Telnyx API
POST
Create an Access Token.
{{baseUrl}}/telephony_credentials/:id/token
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/telephony_credentials/:id/token");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/telephony_credentials/:id/token")
require "http/client"
url = "{{baseUrl}}/telephony_credentials/:id/token"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/telephony_credentials/:id/token"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/telephony_credentials/:id/token");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/telephony_credentials/:id/token"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/telephony_credentials/:id/token HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/telephony_credentials/:id/token")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/telephony_credentials/:id/token"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id/token")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/telephony_credentials/:id/token")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/telephony_credentials/:id/token');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials/:id/token'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/telephony_credentials/:id/token';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/telephony_credentials/:id/token',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id/token")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/telephony_credentials/:id/token',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials/:id/token'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/telephony_credentials/:id/token');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials/:id/token'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/telephony_credentials/:id/token';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/telephony_credentials/:id/token"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/telephony_credentials/:id/token" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/telephony_credentials/:id/token",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/telephony_credentials/:id/token');
echo $response->getBody();
setUrl('{{baseUrl}}/telephony_credentials/:id/token');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/telephony_credentials/:id/token');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/telephony_credentials/:id/token' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/telephony_credentials/:id/token' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/telephony_credentials/:id/token")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/telephony_credentials/:id/token"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/telephony_credentials/:id/token"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/telephony_credentials/:id/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/telephony_credentials/:id/token') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/telephony_credentials/:id/token";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/telephony_credentials/:id/token
http POST {{baseUrl}}/telephony_credentials/:id/token
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/telephony_credentials/:id/token
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/telephony_credentials/:id/token")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
text/plain
RESPONSE BODY text
eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ
POST
Creates an address
{{baseUrl}}/addresses
BODY json
{
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/addresses");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/addresses" {:content-type :json
:form-params {:address_book false
:administrative_area ""
:borough ""
:business_name ""
:country_code ""
:customer_reference ""
:extended_address ""
:first_name ""
:last_name ""
:locality ""
:neighborhood ""
:phone_number ""
:postal_code ""
:street_address ""
:validate_address false}})
require "http/client"
url = "{{baseUrl}}/addresses"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/addresses"),
Content = new StringContent("{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/addresses");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/addresses"
payload := strings.NewReader("{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\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(res)
fmt.Println(string(body))
}
POST /baseUrl/addresses HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 347
{
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/addresses")
.setHeader("content-type", "application/json")
.setBody("{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/addresses"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/addresses")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/addresses")
.header("content-type", "application/json")
.body("{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}")
.asString();
const data = JSON.stringify({
address_book: false,
administrative_area: '',
borough: '',
business_name: '',
country_code: '',
customer_reference: '',
extended_address: '',
first_name: '',
last_name: '',
locality: '',
neighborhood: '',
phone_number: '',
postal_code: '',
street_address: '',
validate_address: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/addresses');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/addresses',
headers: {'content-type': 'application/json'},
data: {
address_book: false,
administrative_area: '',
borough: '',
business_name: '',
country_code: '',
customer_reference: '',
extended_address: '',
first_name: '',
last_name: '',
locality: '',
neighborhood: '',
phone_number: '',
postal_code: '',
street_address: '',
validate_address: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address_book":false,"administrative_area":"","borough":"","business_name":"","country_code":"","customer_reference":"","extended_address":"","first_name":"","last_name":"","locality":"","neighborhood":"","phone_number":"","postal_code":"","street_address":"","validate_address":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/addresses',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address_book": false,\n "administrative_area": "",\n "borough": "",\n "business_name": "",\n "country_code": "",\n "customer_reference": "",\n "extended_address": "",\n "first_name": "",\n "last_name": "",\n "locality": "",\n "neighborhood": "",\n "phone_number": "",\n "postal_code": "",\n "street_address": "",\n "validate_address": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/addresses")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/addresses',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
address_book: false,
administrative_area: '',
borough: '',
business_name: '',
country_code: '',
customer_reference: '',
extended_address: '',
first_name: '',
last_name: '',
locality: '',
neighborhood: '',
phone_number: '',
postal_code: '',
street_address: '',
validate_address: false
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/addresses',
headers: {'content-type': 'application/json'},
body: {
address_book: false,
administrative_area: '',
borough: '',
business_name: '',
country_code: '',
customer_reference: '',
extended_address: '',
first_name: '',
last_name: '',
locality: '',
neighborhood: '',
phone_number: '',
postal_code: '',
street_address: '',
validate_address: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/addresses');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address_book: false,
administrative_area: '',
borough: '',
business_name: '',
country_code: '',
customer_reference: '',
extended_address: '',
first_name: '',
last_name: '',
locality: '',
neighborhood: '',
phone_number: '',
postal_code: '',
street_address: '',
validate_address: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/addresses',
headers: {'content-type': 'application/json'},
data: {
address_book: false,
administrative_area: '',
borough: '',
business_name: '',
country_code: '',
customer_reference: '',
extended_address: '',
first_name: '',
last_name: '',
locality: '',
neighborhood: '',
phone_number: '',
postal_code: '',
street_address: '',
validate_address: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address_book":false,"administrative_area":"","borough":"","business_name":"","country_code":"","customer_reference":"","extended_address":"","first_name":"","last_name":"","locality":"","neighborhood":"","phone_number":"","postal_code":"","street_address":"","validate_address":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"address_book": @NO,
@"administrative_area": @"",
@"borough": @"",
@"business_name": @"",
@"country_code": @"",
@"customer_reference": @"",
@"extended_address": @"",
@"first_name": @"",
@"last_name": @"",
@"locality": @"",
@"neighborhood": @"",
@"phone_number": @"",
@"postal_code": @"",
@"street_address": @"",
@"validate_address": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/addresses"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/addresses" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/addresses",
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([
'address_book' => null,
'administrative_area' => '',
'borough' => '',
'business_name' => '',
'country_code' => '',
'customer_reference' => '',
'extended_address' => '',
'first_name' => '',
'last_name' => '',
'locality' => '',
'neighborhood' => '',
'phone_number' => '',
'postal_code' => '',
'street_address' => '',
'validate_address' => null
]),
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;
}
request('POST', '{{baseUrl}}/addresses', [
'body' => '{
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/addresses');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address_book' => null,
'administrative_area' => '',
'borough' => '',
'business_name' => '',
'country_code' => '',
'customer_reference' => '',
'extended_address' => '',
'first_name' => '',
'last_name' => '',
'locality' => '',
'neighborhood' => '',
'phone_number' => '',
'postal_code' => '',
'street_address' => '',
'validate_address' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address_book' => null,
'administrative_area' => '',
'borough' => '',
'business_name' => '',
'country_code' => '',
'customer_reference' => '',
'extended_address' => '',
'first_name' => '',
'last_name' => '',
'locality' => '',
'neighborhood' => '',
'phone_number' => '',
'postal_code' => '',
'street_address' => '',
'validate_address' => null
]));
$request->setRequestUrl('{{baseUrl}}/addresses');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/addresses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/addresses"
payload = {
"address_book": False,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/addresses"
payload <- "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/addresses")
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 \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/addresses') do |req|
req.body = "{\n \"address_book\": false,\n \"administrative_area\": \"\",\n \"borough\": \"\",\n \"business_name\": \"\",\n \"country_code\": \"\",\n \"customer_reference\": \"\",\n \"extended_address\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"locality\": \"\",\n \"neighborhood\": \"\",\n \"phone_number\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\",\n \"validate_address\": false\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/addresses";
let payload = json!({
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/addresses \
--header 'content-type: application/json' \
--data '{
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
}'
echo '{
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
}' | \
http POST {{baseUrl}}/addresses \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "address_book": false,\n "administrative_area": "",\n "borough": "",\n "business_name": "",\n "country_code": "",\n "customer_reference": "",\n "extended_address": "",\n "first_name": "",\n "last_name": "",\n "locality": "",\n "neighborhood": "",\n "phone_number": "",\n "postal_code": "",\n "street_address": "",\n "validate_address": false\n}' \
--output-document \
- {{baseUrl}}/addresses
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address_book": false,
"administrative_area": "",
"borough": "",
"business_name": "",
"country_code": "",
"customer_reference": "",
"extended_address": "",
"first_name": "",
"last_name": "",
"locality": "",
"neighborhood": "",
"phone_number": "",
"postal_code": "",
"street_address": "",
"validate_address": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/addresses")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"address_book": false,
"administrative_area": "IL",
"borough": "Guadalajara",
"business_name": "Toy-O'Kon",
"country_code": "US",
"created_at": "2018-02-02T22:25:27.521Z",
"customer_reference": "MY REF 001",
"extended_address": "#504",
"first_name": "Alfred",
"id": "1293384261075731499",
"last_name": "Foster",
"locality": "Chicago",
"neighborhood": "Ciudad de los deportes",
"phone_number": "+12125559000",
"postal_code": "60654",
"record_type": "address",
"street_address": "311 W Superior Street",
"updated_at": "2018-02-02T22:25:27.521Z",
"validate_address": true
}
}
DELETE
Deletes an address
{{baseUrl}}/addresses/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/addresses/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/addresses/:id")
require "http/client"
url = "{{baseUrl}}/addresses/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/addresses/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/addresses/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/addresses/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/addresses/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/addresses/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/addresses/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/addresses/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/addresses/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/addresses/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/addresses/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/addresses/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/addresses/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/addresses/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/addresses/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/addresses/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/addresses/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/addresses/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/addresses/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/addresses/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/addresses/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/addresses/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/addresses/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/addresses/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/addresses/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/addresses/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/addresses/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/addresses/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/addresses/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/addresses/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/addresses/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/addresses/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/addresses/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/addresses/:id
http DELETE {{baseUrl}}/addresses/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/addresses/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/addresses/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"address_book": false,
"administrative_area": "IL",
"borough": "Guadalajara",
"business_name": "Toy-O'Kon",
"country_code": "US",
"created_at": "2018-02-02T22:25:27.521Z",
"customer_reference": "MY REF 001",
"extended_address": "#504",
"first_name": "Alfred",
"id": "1293384261075731499",
"last_name": "Foster",
"locality": "Chicago",
"neighborhood": "Ciudad de los deportes",
"phone_number": "+12125559000",
"postal_code": "60654",
"record_type": "address",
"street_address": "311 W Superior Street",
"updated_at": "2018-02-02T22:25:27.521Z",
"validate_address": true
}
}
GET
List all addresses
{{baseUrl}}/addresses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/addresses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/addresses")
require "http/client"
url = "{{baseUrl}}/addresses"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/addresses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/addresses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/addresses"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/addresses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/addresses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/addresses"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/addresses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/addresses")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/addresses');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/addresses'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/addresses';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/addresses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/addresses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/addresses',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/addresses'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/addresses');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/addresses'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/addresses';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/addresses"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/addresses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/addresses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/addresses');
echo $response->getBody();
setUrl('{{baseUrl}}/addresses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/addresses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/addresses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/addresses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/addresses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/addresses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/addresses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/addresses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/addresses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/addresses";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/addresses
http GET {{baseUrl}}/addresses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/addresses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/addresses")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve an address
{{baseUrl}}/addresses/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/addresses/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/addresses/:id")
require "http/client"
url = "{{baseUrl}}/addresses/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/addresses/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/addresses/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/addresses/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/addresses/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/addresses/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/addresses/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/addresses/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/addresses/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/addresses/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/addresses/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/addresses/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/addresses/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/addresses/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/addresses/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/addresses/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/addresses/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/addresses/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/addresses/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/addresses/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/addresses/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/addresses/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/addresses/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/addresses/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/addresses/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/addresses/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/addresses/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/addresses/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/addresses/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/addresses/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/addresses/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/addresses/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/addresses/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/addresses/:id
http GET {{baseUrl}}/addresses/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/addresses/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/addresses/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"address_book": false,
"administrative_area": "IL",
"borough": "Guadalajara",
"business_name": "Toy-O'Kon",
"country_code": "US",
"created_at": "2018-02-02T22:25:27.521Z",
"customer_reference": "MY REF 001",
"extended_address": "#504",
"first_name": "Alfred",
"id": "1293384261075731499",
"last_name": "Foster",
"locality": "Chicago",
"neighborhood": "Ciudad de los deportes",
"phone_number": "+12125559000",
"postal_code": "60654",
"record_type": "address",
"street_address": "311 W Superior Street",
"updated_at": "2018-02-02T22:25:27.521Z",
"validate_address": true
}
}
POST
Validate an address
{{baseUrl}}/addresses/actions/validate
BODY json
{
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/addresses/actions/validate");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/addresses/actions/validate" {:content-type :json
:form-params {:administrative_area ""
:country_code ""
:extended_address ""
:locality ""
:postal_code ""
:street_address ""}})
require "http/client"
url = "{{baseUrl}}/addresses/actions/validate"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/addresses/actions/validate"),
Content = new StringContent("{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/addresses/actions/validate");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/addresses/actions/validate"
payload := strings.NewReader("{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/addresses/actions/validate HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 142
{
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/addresses/actions/validate")
.setHeader("content-type", "application/json")
.setBody("{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/addresses/actions/validate"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/addresses/actions/validate")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/addresses/actions/validate")
.header("content-type", "application/json")
.body("{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}")
.asString();
const data = JSON.stringify({
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/addresses/actions/validate');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/addresses/actions/validate',
headers: {'content-type': 'application/json'},
data: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/addresses/actions/validate';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"administrative_area":"","country_code":"","extended_address":"","locality":"","postal_code":"","street_address":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/addresses/actions/validate',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "administrative_area": "",\n "country_code": "",\n "extended_address": "",\n "locality": "",\n "postal_code": "",\n "street_address": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/addresses/actions/validate")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/addresses/actions/validate',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/addresses/actions/validate',
headers: {'content-type': 'application/json'},
body: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/addresses/actions/validate');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/addresses/actions/validate',
headers: {'content-type': 'application/json'},
data: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/addresses/actions/validate';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"administrative_area":"","country_code":"","extended_address":"","locality":"","postal_code":"","street_address":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"administrative_area": @"",
@"country_code": @"",
@"extended_address": @"",
@"locality": @"",
@"postal_code": @"",
@"street_address": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/addresses/actions/validate"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/addresses/actions/validate" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/addresses/actions/validate",
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([
'administrative_area' => '',
'country_code' => '',
'extended_address' => '',
'locality' => '',
'postal_code' => '',
'street_address' => ''
]),
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;
}
request('POST', '{{baseUrl}}/addresses/actions/validate', [
'body' => '{
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/addresses/actions/validate');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'administrative_area' => '',
'country_code' => '',
'extended_address' => '',
'locality' => '',
'postal_code' => '',
'street_address' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'administrative_area' => '',
'country_code' => '',
'extended_address' => '',
'locality' => '',
'postal_code' => '',
'street_address' => ''
]));
$request->setRequestUrl('{{baseUrl}}/addresses/actions/validate');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/addresses/actions/validate' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/addresses/actions/validate' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/addresses/actions/validate", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/addresses/actions/validate"
payload = {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/addresses/actions/validate"
payload <- "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/addresses/actions/validate")
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 \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/addresses/actions/validate') do |req|
req.body = "{\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/addresses/actions/validate";
let payload = json!({
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/addresses/actions/validate \
--header 'content-type: application/json' \
--data '{
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}'
echo '{
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}' | \
http POST {{baseUrl}}/addresses/actions/validate \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "administrative_area": "",\n "country_code": "",\n "extended_address": "",\n "locality": "",\n "postal_code": "",\n "street_address": ""\n}' \
--output-document \
- {{baseUrl}}/addresses/actions/validate
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/addresses/actions/validate")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"record_type": "address_validation",
"result": "valid"
}
}
POST
Creates an authentication provider
{{baseUrl}}/authentication_providers
BODY json
{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/authentication_providers");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/authentication_providers" {:content-type :json
:form-params {:active false
:name ""
:settings {:idp_cert_fingerprint ""
:idp_cert_fingerprint_algorithm ""
:idp_entity_id ""
:idp_sso_target_url ""}
:settings_url ""
:short_name ""}})
require "http/client"
url = "{{baseUrl}}/authentication_providers"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/authentication_providers"),
Content = new StringContent("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/authentication_providers");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/authentication_providers"
payload := strings.NewReader("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/authentication_providers HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 226
{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/authentication_providers")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/authentication_providers"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/authentication_providers")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/authentication_providers")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
.asString();
const data = JSON.stringify({
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/authentication_providers');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/authentication_providers',
headers: {'content-type': 'application/json'},
data: {
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/authentication_providers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"name":"","settings":{"idp_cert_fingerprint":"","idp_cert_fingerprint_algorithm":"","idp_entity_id":"","idp_sso_target_url":""},"settings_url":"","short_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/authentication_providers',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "name": "",\n "settings": {\n "idp_cert_fingerprint": "",\n "idp_cert_fingerprint_algorithm": "",\n "idp_entity_id": "",\n "idp_sso_target_url": ""\n },\n "settings_url": "",\n "short_name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/authentication_providers")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/authentication_providers',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/authentication_providers',
headers: {'content-type': 'application/json'},
body: {
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/authentication_providers');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/authentication_providers',
headers: {'content-type': 'application/json'},
data: {
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/authentication_providers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"name":"","settings":{"idp_cert_fingerprint":"","idp_cert_fingerprint_algorithm":"","idp_entity_id":"","idp_sso_target_url":""},"settings_url":"","short_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"name": @"",
@"settings": @{ @"idp_cert_fingerprint": @"", @"idp_cert_fingerprint_algorithm": @"", @"idp_entity_id": @"", @"idp_sso_target_url": @"" },
@"settings_url": @"",
@"short_name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/authentication_providers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/authentication_providers" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/authentication_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([
'active' => null,
'name' => '',
'settings' => [
'idp_cert_fingerprint' => '',
'idp_cert_fingerprint_algorithm' => '',
'idp_entity_id' => '',
'idp_sso_target_url' => ''
],
'settings_url' => '',
'short_name' => ''
]),
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;
}
request('POST', '{{baseUrl}}/authentication_providers', [
'body' => '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/authentication_providers');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'name' => '',
'settings' => [
'idp_cert_fingerprint' => '',
'idp_cert_fingerprint_algorithm' => '',
'idp_entity_id' => '',
'idp_sso_target_url' => ''
],
'settings_url' => '',
'short_name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'name' => '',
'settings' => [
'idp_cert_fingerprint' => '',
'idp_cert_fingerprint_algorithm' => '',
'idp_entity_id' => '',
'idp_sso_target_url' => ''
],
'settings_url' => '',
'short_name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/authentication_providers');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/authentication_providers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/authentication_providers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/authentication_providers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/authentication_providers"
payload = {
"active": False,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/authentication_providers"
payload <- "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/authentication_providers")
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 \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/authentication_providers') do |req|
req.body = "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/authentication_providers";
let payload = json!({
"active": false,
"name": "",
"settings": json!({
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
}),
"settings_url": "",
"short_name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/authentication_providers \
--header 'content-type: application/json' \
--data '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}'
echo '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}' | \
http POST {{baseUrl}}/authentication_providers \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "name": "",\n "settings": {\n "idp_cert_fingerprint": "",\n "idp_cert_fingerprint_algorithm": "",\n "idp_entity_id": "",\n "idp_sso_target_url": ""\n },\n "settings_url": "",\n "short_name": ""\n}' \
--output-document \
- {{baseUrl}}/authentication_providers
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"name": "",
"settings": [
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
],
"settings_url": "",
"short_name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/authentication_providers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"created_at": "2018-02-02T22:25:27.521Z",
"id": "35146afd-df93-4963-b1e9-1a085e2ae874",
"name": "Okta",
"organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
"record_type": "authentication_provider",
"short_name": "myorg",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
DELETE
Deletes an authentication provider
{{baseUrl}}/authentication_providers/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/authentication_providers/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/authentication_providers/:id")
require "http/client"
url = "{{baseUrl}}/authentication_providers/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/authentication_providers/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/authentication_providers/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/authentication_providers/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/authentication_providers/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/authentication_providers/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/authentication_providers/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/authentication_providers/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/authentication_providers/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/authentication_providers/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/authentication_providers/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/authentication_providers/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/authentication_providers/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/authentication_providers/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/authentication_providers/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/authentication_providers/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/authentication_providers/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/authentication_providers/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/authentication_providers/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/authentication_providers/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/authentication_providers/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/authentication_providers/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/authentication_providers/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/authentication_providers/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/authentication_providers/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/authentication_providers/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/authentication_providers/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/authentication_providers/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/authentication_providers/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/authentication_providers/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/authentication_providers/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/authentication_providers/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/authentication_providers/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/authentication_providers/:id
http DELETE {{baseUrl}}/authentication_providers/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/authentication_providers/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/authentication_providers/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"created_at": "2018-02-02T22:25:27.521Z",
"id": "35146afd-df93-4963-b1e9-1a085e2ae874",
"name": "Okta",
"organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
"record_type": "authentication_provider",
"short_name": "myorg",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
List all SSO authentication providers
{{baseUrl}}/authentication_providers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/authentication_providers");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/authentication_providers")
require "http/client"
url = "{{baseUrl}}/authentication_providers"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/authentication_providers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/authentication_providers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/authentication_providers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/authentication_providers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/authentication_providers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/authentication_providers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/authentication_providers")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/authentication_providers")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/authentication_providers');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/authentication_providers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/authentication_providers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/authentication_providers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/authentication_providers")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/authentication_providers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/authentication_providers'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/authentication_providers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/authentication_providers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/authentication_providers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/authentication_providers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/authentication_providers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/authentication_providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/authentication_providers');
echo $response->getBody();
setUrl('{{baseUrl}}/authentication_providers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/authentication_providers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/authentication_providers' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/authentication_providers' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/authentication_providers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/authentication_providers"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/authentication_providers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/authentication_providers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/authentication_providers') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/authentication_providers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/authentication_providers
http GET {{baseUrl}}/authentication_providers
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/authentication_providers
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/authentication_providers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve an authentication provider
{{baseUrl}}/authentication_providers/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/authentication_providers/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/authentication_providers/:id")
require "http/client"
url = "{{baseUrl}}/authentication_providers/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/authentication_providers/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/authentication_providers/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/authentication_providers/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/authentication_providers/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/authentication_providers/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/authentication_providers/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/authentication_providers/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/authentication_providers/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/authentication_providers/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/authentication_providers/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/authentication_providers/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/authentication_providers/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/authentication_providers/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/authentication_providers/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/authentication_providers/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/authentication_providers/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/authentication_providers/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/authentication_providers/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/authentication_providers/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/authentication_providers/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/authentication_providers/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/authentication_providers/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/authentication_providers/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/authentication_providers/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/authentication_providers/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/authentication_providers/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/authentication_providers/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/authentication_providers/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/authentication_providers/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/authentication_providers/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/authentication_providers/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/authentication_providers/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/authentication_providers/:id
http GET {{baseUrl}}/authentication_providers/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/authentication_providers/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/authentication_providers/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"created_at": "2018-02-02T22:25:27.521Z",
"id": "35146afd-df93-4963-b1e9-1a085e2ae874",
"name": "Okta",
"organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
"record_type": "authentication_provider",
"short_name": "myorg",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
PATCH
Update a authentication provider
{{baseUrl}}/authentication_providers/:id
QUERY PARAMS
id
BODY json
{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/authentication_providers/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/authentication_providers/:id" {:content-type :json
:form-params {:active false
:name ""
:settings {:idp_cert_fingerprint ""
:idp_cert_fingerprint_algorithm ""
:idp_entity_id ""
:idp_sso_target_url ""}
:settings_url ""
:short_name ""}})
require "http/client"
url = "{{baseUrl}}/authentication_providers/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/authentication_providers/:id"),
Content = new StringContent("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/authentication_providers/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/authentication_providers/:id"
payload := strings.NewReader("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/authentication_providers/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 226
{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/authentication_providers/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/authentication_providers/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/authentication_providers/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/authentication_providers/:id")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
.asString();
const data = JSON.stringify({
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/authentication_providers/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/authentication_providers/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/authentication_providers/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"name":"","settings":{"idp_cert_fingerprint":"","idp_cert_fingerprint_algorithm":"","idp_entity_id":"","idp_sso_target_url":""},"settings_url":"","short_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/authentication_providers/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "name": "",\n "settings": {\n "idp_cert_fingerprint": "",\n "idp_cert_fingerprint_algorithm": "",\n "idp_entity_id": "",\n "idp_sso_target_url": ""\n },\n "settings_url": "",\n "short_name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/authentication_providers/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/authentication_providers/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/authentication_providers/:id',
headers: {'content-type': 'application/json'},
body: {
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/authentication_providers/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/authentication_providers/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
name: '',
settings: {
idp_cert_fingerprint: '',
idp_cert_fingerprint_algorithm: '',
idp_entity_id: '',
idp_sso_target_url: ''
},
settings_url: '',
short_name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/authentication_providers/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"name":"","settings":{"idp_cert_fingerprint":"","idp_cert_fingerprint_algorithm":"","idp_entity_id":"","idp_sso_target_url":""},"settings_url":"","short_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"name": @"",
@"settings": @{ @"idp_cert_fingerprint": @"", @"idp_cert_fingerprint_algorithm": @"", @"idp_entity_id": @"", @"idp_sso_target_url": @"" },
@"settings_url": @"",
@"short_name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/authentication_providers/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/authentication_providers/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/authentication_providers/:id",
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([
'active' => null,
'name' => '',
'settings' => [
'idp_cert_fingerprint' => '',
'idp_cert_fingerprint_algorithm' => '',
'idp_entity_id' => '',
'idp_sso_target_url' => ''
],
'settings_url' => '',
'short_name' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/authentication_providers/:id', [
'body' => '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/authentication_providers/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'name' => '',
'settings' => [
'idp_cert_fingerprint' => '',
'idp_cert_fingerprint_algorithm' => '',
'idp_entity_id' => '',
'idp_sso_target_url' => ''
],
'settings_url' => '',
'short_name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'name' => '',
'settings' => [
'idp_cert_fingerprint' => '',
'idp_cert_fingerprint_algorithm' => '',
'idp_entity_id' => '',
'idp_sso_target_url' => ''
],
'settings_url' => '',
'short_name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/authentication_providers/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/authentication_providers/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/authentication_providers/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/authentication_providers/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/authentication_providers/:id"
payload = {
"active": False,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/authentication_providers/:id"
payload <- "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/authentication_providers/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/authentication_providers/:id') do |req|
req.body = "{\n \"active\": false,\n \"name\": \"\",\n \"settings\": {\n \"idp_cert_fingerprint\": \"\",\n \"idp_cert_fingerprint_algorithm\": \"\",\n \"idp_entity_id\": \"\",\n \"idp_sso_target_url\": \"\"\n },\n \"settings_url\": \"\",\n \"short_name\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/authentication_providers/:id";
let payload = json!({
"active": false,
"name": "",
"settings": json!({
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
}),
"settings_url": "",
"short_name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/authentication_providers/:id \
--header 'content-type: application/json' \
--data '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}'
echo '{
"active": false,
"name": "",
"settings": {
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
},
"settings_url": "",
"short_name": ""
}' | \
http PATCH {{baseUrl}}/authentication_providers/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "name": "",\n "settings": {\n "idp_cert_fingerprint": "",\n "idp_cert_fingerprint_algorithm": "",\n "idp_entity_id": "",\n "idp_sso_target_url": ""\n },\n "settings_url": "",\n "short_name": ""\n}' \
--output-document \
- {{baseUrl}}/authentication_providers/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"name": "",
"settings": [
"idp_cert_fingerprint": "",
"idp_cert_fingerprint_algorithm": "",
"idp_entity_id": "",
"idp_sso_target_url": ""
],
"settings_url": "",
"short_name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/authentication_providers/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"created_at": "2018-02-02T22:25:27.521Z",
"id": "35146afd-df93-4963-b1e9-1a085e2ae874",
"name": "Okta",
"organization_id": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7",
"record_type": "authentication_provider",
"short_name": "myorg",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Retrieve user balance details
{{baseUrl}}/balance
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/balance");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/balance")
require "http/client"
url = "{{baseUrl}}/balance"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/balance"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/balance");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/balance"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/balance HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/balance")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/balance"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/balance")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/balance")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/balance');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/balance'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/balance';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/balance',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/balance")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/balance',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/balance'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/balance');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/balance'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/balance';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/balance"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/balance" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/balance');
echo $response->getBody();
setUrl('{{baseUrl}}/balance');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/balance');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/balance' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/balance' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/balance")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/balance"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/balance"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/balance') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/balance";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/balance
http GET {{baseUrl}}/balance
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/balance
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/balance")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"available_credit": "400.00",
"balance": "300.00",
"credit_limit": "100.00",
"currency": "USD",
"record_type": "balance"
}
}
POST
Create a billing group
{{baseUrl}}/billing_groups
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/billing_groups");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/billing_groups")
require "http/client"
url = "{{baseUrl}}/billing_groups"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/billing_groups"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/billing_groups");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/billing_groups"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/billing_groups HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/billing_groups")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/billing_groups"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/billing_groups")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/billing_groups")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/billing_groups');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/billing_groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/billing_groups';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/billing_groups',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/billing_groups")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/billing_groups',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/billing_groups'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/billing_groups');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/billing_groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/billing_groups';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/billing_groups"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/billing_groups" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/billing_groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/billing_groups');
echo $response->getBody();
setUrl('{{baseUrl}}/billing_groups');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/billing_groups');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/billing_groups' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/billing_groups' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/billing_groups", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/billing_groups"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/billing_groups"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/billing_groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/billing_groups') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/billing_groups";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/billing_groups
http POST {{baseUrl}}/billing_groups
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/billing_groups
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/billing_groups")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-10-15T10:07:15.527Z",
"deleted_at": null,
"id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"name": "My billing group name",
"organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "billing_group",
"updated_at": "2019-10-15T10:07:15.527Z"
}
}
DELETE
Delete a billing group
{{baseUrl}}/billing_groups/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/billing_groups/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/billing_groups/:id")
require "http/client"
url = "{{baseUrl}}/billing_groups/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/billing_groups/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/billing_groups/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/billing_groups/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/billing_groups/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/billing_groups/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/billing_groups/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/billing_groups/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/billing_groups/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/billing_groups/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/billing_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/billing_groups/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/billing_groups/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/billing_groups/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/billing_groups/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/billing_groups/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/billing_groups/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/billing_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/billing_groups/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/billing_groups/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/billing_groups/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/billing_groups/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/billing_groups/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/billing_groups/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/billing_groups/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/billing_groups/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/billing_groups/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/billing_groups/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/billing_groups/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/billing_groups/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/billing_groups/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/billing_groups/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/billing_groups/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/billing_groups/:id
http DELETE {{baseUrl}}/billing_groups/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/billing_groups/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/billing_groups/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-10-15T10:07:15.527Z",
"deleted_at": null,
"id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"name": "My billing group name",
"organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "billing_group",
"updated_at": "2019-10-15T10:07:15.527Z"
}
}
GET
List all billing groups
{{baseUrl}}/billing_groups
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/billing_groups");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/billing_groups")
require "http/client"
url = "{{baseUrl}}/billing_groups"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/billing_groups"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/billing_groups");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/billing_groups"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/billing_groups HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/billing_groups")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/billing_groups"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/billing_groups")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/billing_groups")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/billing_groups');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/billing_groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/billing_groups';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/billing_groups',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/billing_groups")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/billing_groups',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/billing_groups'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/billing_groups');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/billing_groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/billing_groups';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/billing_groups"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/billing_groups" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/billing_groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/billing_groups');
echo $response->getBody();
setUrl('{{baseUrl}}/billing_groups');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/billing_groups');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/billing_groups' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/billing_groups' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/billing_groups")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/billing_groups"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/billing_groups"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/billing_groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/billing_groups') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/billing_groups";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/billing_groups
http GET {{baseUrl}}/billing_groups
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/billing_groups
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/billing_groups")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"created_at": "2019-10-15T10:07:15.527Z",
"deleted_at": null,
"id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"name": "My billing group name",
"organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "billing_group",
"updated_at": "2019-10-15T10:07:15.527Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a billing group
{{baseUrl}}/billing_groups/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/billing_groups/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/billing_groups/:id")
require "http/client"
url = "{{baseUrl}}/billing_groups/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/billing_groups/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/billing_groups/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/billing_groups/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/billing_groups/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/billing_groups/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/billing_groups/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/billing_groups/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/billing_groups/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/billing_groups/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/billing_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/billing_groups/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/billing_groups/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/billing_groups/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/billing_groups/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/billing_groups/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/billing_groups/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/billing_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/billing_groups/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/billing_groups/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/billing_groups/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/billing_groups/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/billing_groups/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/billing_groups/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/billing_groups/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/billing_groups/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/billing_groups/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/billing_groups/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/billing_groups/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/billing_groups/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/billing_groups/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/billing_groups/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/billing_groups/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/billing_groups/:id
http GET {{baseUrl}}/billing_groups/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/billing_groups/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/billing_groups/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-10-15T10:07:15.527Z",
"deleted_at": null,
"id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"name": "My billing group name",
"organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "billing_group",
"updated_at": "2019-10-15T10:07:15.527Z"
}
}
PATCH
Update a billing group
{{baseUrl}}/billing_groups/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/billing_groups/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/billing_groups/:id")
require "http/client"
url = "{{baseUrl}}/billing_groups/:id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/billing_groups/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/billing_groups/:id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/billing_groups/:id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/billing_groups/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/billing_groups/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/billing_groups/:id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/billing_groups/:id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/billing_groups/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/billing_groups/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PATCH', url: '{{baseUrl}}/billing_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/billing_groups/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/billing_groups/:id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/billing_groups/:id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/billing_groups/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'PATCH', url: '{{baseUrl}}/billing_groups/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/billing_groups/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'PATCH', url: '{{baseUrl}}/billing_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/billing_groups/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/billing_groups/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/billing_groups/:id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/billing_groups/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/billing_groups/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/billing_groups/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/billing_groups/:id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/billing_groups/:id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/billing_groups/:id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("PATCH", "/baseUrl/billing_groups/:id", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/billing_groups/:id"
payload = ""
response = requests.patch(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/billing_groups/:id"
payload <- ""
response <- VERB("PATCH", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/billing_groups/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/billing_groups/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/billing_groups/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/billing_groups/:id
http PATCH {{baseUrl}}/billing_groups/:id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/billing_groups/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/billing_groups/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-10-15T10:07:15.527Z",
"deleted_at": null,
"id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"name": "My billing group name",
"organization_id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "billing_group",
"updated_at": "2019-10-15T10:07:15.527Z"
}
}
POST
Creates several credentials
{{baseUrl}}/actions/bulk/telephony_credentials
BODY json
{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/actions/bulk/telephony_credentials");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/actions/bulk/telephony_credentials" {:content-type :json
:form-params {:amount 0
:connection_id ""
:name ""
:tag ""}})
require "http/client"
url = "{{baseUrl}}/actions/bulk/telephony_credentials"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/actions/bulk/telephony_credentials"),
Content = new StringContent("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/actions/bulk/telephony_credentials");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/actions/bulk/telephony_credentials"
payload := strings.NewReader("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/actions/bulk/telephony_credentials HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 67
{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/actions/bulk/telephony_credentials")
.setHeader("content-type", "application/json")
.setBody("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/actions/bulk/telephony_credentials"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/actions/bulk/telephony_credentials")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/actions/bulk/telephony_credentials")
.header("content-type", "application/json")
.body("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
.asString();
const data = JSON.stringify({
amount: 0,
connection_id: '',
name: '',
tag: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/actions/bulk/telephony_credentials');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
headers: {'content-type': 'application/json'},
data: {amount: 0, connection_id: '', name: '', tag: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/actions/bulk/telephony_credentials';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"amount":0,"connection_id":"","name":"","tag":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "amount": 0,\n "connection_id": "",\n "name": "",\n "tag": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/actions/bulk/telephony_credentials")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/actions/bulk/telephony_credentials',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({amount: 0, connection_id: '', name: '', tag: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
headers: {'content-type': 'application/json'},
body: {amount: 0, connection_id: '', name: '', tag: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/actions/bulk/telephony_credentials');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
amount: 0,
connection_id: '',
name: '',
tag: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
headers: {'content-type': 'application/json'},
data: {amount: 0, connection_id: '', name: '', tag: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/actions/bulk/telephony_credentials';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"amount":0,"connection_id":"","name":"","tag":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"amount": @0,
@"connection_id": @"",
@"name": @"",
@"tag": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/actions/bulk/telephony_credentials"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/actions/bulk/telephony_credentials" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/actions/bulk/telephony_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([
'amount' => 0,
'connection_id' => '',
'name' => '',
'tag' => ''
]),
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;
}
request('POST', '{{baseUrl}}/actions/bulk/telephony_credentials', [
'body' => '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/actions/bulk/telephony_credentials');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'amount' => 0,
'connection_id' => '',
'name' => '',
'tag' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'amount' => 0,
'connection_id' => '',
'name' => '',
'tag' => ''
]));
$request->setRequestUrl('{{baseUrl}}/actions/bulk/telephony_credentials');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/actions/bulk/telephony_credentials' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/actions/bulk/telephony_credentials' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/actions/bulk/telephony_credentials", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/actions/bulk/telephony_credentials"
payload = {
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/actions/bulk/telephony_credentials"
payload <- "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/actions/bulk/telephony_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 \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/actions/bulk/telephony_credentials') do |req|
req.body = "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/actions/bulk/telephony_credentials";
let payload = json!({
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/actions/bulk/telephony_credentials \
--header 'content-type: application/json' \
--data '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}'
echo '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}' | \
http POST {{baseUrl}}/actions/bulk/telephony_credentials \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "amount": 0,\n "connection_id": "",\n "name": "",\n "tag": ""\n}' \
--output-document \
- {{baseUrl}}/actions/bulk/telephony_credentials
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/actions/bulk/telephony_credentials")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"credentials": 0
}
}
DELETE
Delete several credentials
{{baseUrl}}/actions/bulk/telephony_credentials
QUERY PARAMS
filter[tag]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/actions/bulk/telephony_credentials" {:query-params {:filter[tag] ""}})
require "http/client"
url = "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/actions/bulk/telephony_credentials?filter%5Btag%5D= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
params: {'filter[tag]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/actions/bulk/telephony_credentials?filter%5Btag%5D=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
qs: {'filter[tag]': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/actions/bulk/telephony_credentials');
req.query({
'filter[tag]': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
params: {'filter[tag]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=');
echo $response->getBody();
setUrl('{{baseUrl}}/actions/bulk/telephony_credentials');
$request->setMethod(HTTP_METH_DELETE);
$request->setQueryData([
'filter[tag]' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/actions/bulk/telephony_credentials');
$request->setRequestMethod('DELETE');
$request->setQuery(new http\QueryString([
'filter[tag]' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/actions/bulk/telephony_credentials?filter%5Btag%5D=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/actions/bulk/telephony_credentials"
querystring = {"filter[tag]":""}
response = requests.delete(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/actions/bulk/telephony_credentials"
queryString <- list(filter[tag] = "")
response <- VERB("DELETE", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/actions/bulk/telephony_credentials') do |req|
req.params['filter[tag]'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/actions/bulk/telephony_credentials";
let querystring = [
("filter[tag]", ""),
];
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D='
http DELETE '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D='
wget --quiet \
--method DELETE \
--output-document \
- '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"credentials": 0
}
}
POST
Perform activate or deactivate action on all credentials filtered by the provided tag.
{{baseUrl}}/actions/:action/telephony_credentials
QUERY PARAMS
filter[tag]
action
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/actions/:action/telephony_credentials" {:query-params {:filter[tag] ""}})
require "http/client"
url = "{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D="
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D="
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/actions/:action/telephony_credentials?filter%5Btag%5D= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D="))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/:action/telephony_credentials',
params: {'filter[tag]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/actions/:action/telephony_credentials?filter%5Btag%5D=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/:action/telephony_credentials',
qs: {'filter[tag]': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/actions/:action/telephony_credentials');
req.query({
'filter[tag]': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/:action/telephony_credentials',
params: {'filter[tag]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=');
echo $response->getBody();
setUrl('{{baseUrl}}/actions/:action/telephony_credentials');
$request->setMethod(HTTP_METH_POST);
$request->setQueryData([
'filter[tag]' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/actions/:action/telephony_credentials');
$request->setRequestMethod('POST');
$request->setQuery(new http\QueryString([
'filter[tag]' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/actions/:action/telephony_credentials?filter%5Btag%5D=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/actions/:action/telephony_credentials"
querystring = {"filter[tag]":""}
response = requests.post(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/actions/:action/telephony_credentials"
queryString <- list(filter[tag] = "")
response <- VERB("POST", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/actions/:action/telephony_credentials') do |req|
req.params['filter[tag]'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/actions/:action/telephony_credentials";
let querystring = [
("filter[tag]", ""),
];
let client = reqwest::Client::new();
let response = client.post(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D='
http POST '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D='
wget --quiet \
--method POST \
--output-document \
- '{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/actions/:action/telephony_credentials?filter%5Btag%5D=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"credentials": 0
}
}
PATCH
Update several credentials
{{baseUrl}}/actions/bulk/telephony_credentials
QUERY PARAMS
filter[tag]
BODY json
{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/actions/bulk/telephony_credentials" {:query-params {:filter[tag] ""}
:content-type :json
:form-params {:amount 0
:connection_id ""
:name ""
:tag ""}})
require "http/client"
url = "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="),
Content = new StringContent("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="
payload := strings.NewReader("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/actions/bulk/telephony_credentials?filter%5Btag%5D= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 67
{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
.setHeader("content-type", "application/json")
.setBody("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
.header("content-type", "application/json")
.body("{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
.asString();
const data = JSON.stringify({
amount: 0,
connection_id: '',
name: '',
tag: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
params: {'filter[tag]': ''},
headers: {'content-type': 'application/json'},
data: {amount: 0, connection_id: '', name: '', tag: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"amount":0,"connection_id":"","name":"","tag":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "amount": 0,\n "connection_id": "",\n "name": "",\n "tag": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/actions/bulk/telephony_credentials?filter%5Btag%5D=',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({amount: 0, connection_id: '', name: '', tag: ''}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
qs: {'filter[tag]': ''},
headers: {'content-type': 'application/json'},
body: {amount: 0, connection_id: '', name: '', tag: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/actions/bulk/telephony_credentials');
req.query({
'filter[tag]': ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
amount: 0,
connection_id: '',
name: '',
tag: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/actions/bulk/telephony_credentials',
params: {'filter[tag]': ''},
headers: {'content-type': 'application/json'},
data: {amount: 0, connection_id: '', name: '', tag: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"amount":0,"connection_id":"","name":"","tag":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"amount": @0,
@"connection_id": @"",
@"name": @"",
@"tag": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=",
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([
'amount' => 0,
'connection_id' => '',
'name' => '',
'tag' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=', [
'body' => '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/actions/bulk/telephony_credentials');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setQueryData([
'filter[tag]' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'amount' => 0,
'connection_id' => '',
'name' => '',
'tag' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'amount' => 0,
'connection_id' => '',
'name' => '',
'tag' => ''
]));
$request->setRequestUrl('{{baseUrl}}/actions/bulk/telephony_credentials');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'filter[tag]' => ''
]));
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/actions/bulk/telephony_credentials?filter%5Btag%5D=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/actions/bulk/telephony_credentials"
querystring = {"filter[tag]":""}
payload = {
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/actions/bulk/telephony_credentials"
queryString <- list(filter[tag] = "")
payload <- "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/actions/bulk/telephony_credentials') do |req|
req.params['filter[tag]'] = ''
req.body = "{\n \"amount\": 0,\n \"connection_id\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/actions/bulk/telephony_credentials";
let querystring = [
("filter[tag]", ""),
];
let payload = json!({
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=' \
--header 'content-type: application/json' \
--data '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}'
echo '{
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
}' | \
http PATCH '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=' \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "amount": 0,\n "connection_id": "",\n "name": "",\n "tag": ""\n}' \
--output-document \
- '{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D='
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"amount": 0,
"connection_id": "",
"name": "",
"tag": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/actions/bulk/telephony_credentials?filter%5Btag%5D=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"credentials": 0
}
}
POST
Answer call
{{baseUrl}}/calls/:call_control_id/actions/answer
QUERY PARAMS
call_control_id
BODY json
{
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/answer");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/answer" {:content-type :json
:form-params {:billing_group_id ""
:client_state ""
:command_id ""
:webhook_url ""
:webhook_url_method ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/answer"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/answer"),
Content = new StringContent("{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/answer");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/answer"
payload := strings.NewReader("{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/answer HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 119
{
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/answer")
.setHeader("content-type", "application/json")
.setBody("{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/answer"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/answer")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/answer")
.header("content-type", "application/json")
.body("{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
.asString();
const data = JSON.stringify({
billing_group_id: '',
client_state: '',
command_id: '',
webhook_url: '',
webhook_url_method: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/answer');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/answer',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
client_state: '',
command_id: '',
webhook_url: '',
webhook_url_method: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/answer';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","client_state":"","command_id":"","webhook_url":"","webhook_url_method":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/answer',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "billing_group_id": "",\n "client_state": "",\n "command_id": "",\n "webhook_url": "",\n "webhook_url_method": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/answer")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/answer',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
billing_group_id: '',
client_state: '',
command_id: '',
webhook_url: '',
webhook_url_method: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/answer',
headers: {'content-type': 'application/json'},
body: {
billing_group_id: '',
client_state: '',
command_id: '',
webhook_url: '',
webhook_url_method: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/answer');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
billing_group_id: '',
client_state: '',
command_id: '',
webhook_url: '',
webhook_url_method: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/answer',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
client_state: '',
command_id: '',
webhook_url: '',
webhook_url_method: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/answer';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","client_state":"","command_id":"","webhook_url":"","webhook_url_method":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"billing_group_id": @"",
@"client_state": @"",
@"command_id": @"",
@"webhook_url": @"",
@"webhook_url_method": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/answer"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/answer" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/answer",
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([
'billing_group_id' => '',
'client_state' => '',
'command_id' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/answer', [
'body' => '{
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/answer');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'billing_group_id' => '',
'client_state' => '',
'command_id' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'billing_group_id' => '',
'client_state' => '',
'command_id' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/answer');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/answer' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/answer' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/answer", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/answer"
payload = {
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/answer"
payload <- "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/answer")
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 \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/answer') do |req|
req.body = "{\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/answer";
let payload = json!({
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/answer \
--header 'content-type: application/json' \
--data '{
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
}'
echo '{
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/answer \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "billing_group_id": "",\n "client_state": "",\n "command_id": "",\n "webhook_url": "",\n "webhook_url_method": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/answer
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"billing_group_id": "",
"client_state": "",
"command_id": "",
"webhook_url": "",
"webhook_url_method": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/answer")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Bridge calls
{{baseUrl}}/calls/:call_control_id/actions/bridge
QUERY PARAMS
call_control_id
BODY json
{
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/bridge");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/bridge" {:content-type :json
:form-params {:call_control_id ""
:client_state ""
:command_id ""
:park_after_unbridge ""
:queue ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/bridge"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/bridge"),
Content = new StringContent("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/bridge");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/bridge"
payload := strings.NewReader("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/bridge HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 113
{
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/bridge")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/bridge"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/bridge")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/bridge")
.header("content-type", "application/json")
.body("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}")
.asString();
const data = JSON.stringify({
call_control_id: '',
client_state: '',
command_id: '',
park_after_unbridge: '',
queue: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/bridge');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/bridge',
headers: {'content-type': 'application/json'},
data: {
call_control_id: '',
client_state: '',
command_id: '',
park_after_unbridge: '',
queue: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/bridge';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_id":"","client_state":"","command_id":"","park_after_unbridge":"","queue":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/bridge',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_control_id": "",\n "client_state": "",\n "command_id": "",\n "park_after_unbridge": "",\n "queue": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/bridge")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/bridge',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
call_control_id: '',
client_state: '',
command_id: '',
park_after_unbridge: '',
queue: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/bridge',
headers: {'content-type': 'application/json'},
body: {
call_control_id: '',
client_state: '',
command_id: '',
park_after_unbridge: '',
queue: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/bridge');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_control_id: '',
client_state: '',
command_id: '',
park_after_unbridge: '',
queue: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/bridge',
headers: {'content-type': 'application/json'},
data: {
call_control_id: '',
client_state: '',
command_id: '',
park_after_unbridge: '',
queue: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/bridge';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_id":"","client_state":"","command_id":"","park_after_unbridge":"","queue":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_control_id": @"",
@"client_state": @"",
@"command_id": @"",
@"park_after_unbridge": @"",
@"queue": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/bridge"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/bridge" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/bridge",
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([
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'park_after_unbridge' => '',
'queue' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/bridge', [
'body' => '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/bridge');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'park_after_unbridge' => '',
'queue' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'park_after_unbridge' => '',
'queue' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/bridge');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/bridge' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/bridge' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/bridge", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/bridge"
payload = {
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/bridge"
payload <- "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/bridge")
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 \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/bridge') do |req|
req.body = "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"park_after_unbridge\": \"\",\n \"queue\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/bridge";
let payload = json!({
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/bridge \
--header 'content-type: application/json' \
--data '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
}'
echo '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/bridge \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_control_id": "",\n "client_state": "",\n "command_id": "",\n "park_after_unbridge": "",\n "queue": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/bridge
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"call_control_id": "",
"client_state": "",
"command_id": "",
"park_after_unbridge": "",
"queue": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/bridge")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Dial
{{baseUrl}}/calls
BODY json
{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls" {:content-type :json
:form-params {:answering_machine_detection ""
:answering_machine_detection_config {:after_greeting_silence_millis 0
:between_words_silence_millis 0
:greeting_duration_millis 0
:greeting_silence_duration_millis 0
:greeting_total_analysis_time_millis 0
:initial_silence_millis 0
:maximum_number_of_words 0
:maximum_word_length_millis 0
:silence_threshold 0
:total_analysis_time_millis 0}
:audio_url ""
:billing_group_id ""
:client_state ""
:command_id ""
:connection_id ""
:custom_headers [{:name ""
:value ""}]
:from ""
:from_display_name ""
:link_to ""
:media_name ""
:sip_auth_password ""
:sip_auth_username ""
:time_limit_secs 0
:timeout_secs 0
:to ""
:webhook_url ""
:webhook_url_method ""}})
require "http/client"
url = "{{baseUrl}}/calls"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls"),
Content = new StringContent("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls"
payload := strings.NewReader("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 880
{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls")
.setHeader("content-type", "application/json")
.setBody("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls")
.header("content-type", "application/json")
.body("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
.asString();
const data = JSON.stringify({
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
billing_group_id: '',
client_state: '',
command_id: '',
connection_id: '',
custom_headers: [
{
name: '',
value: ''
}
],
from: '',
from_display_name: '',
link_to: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls',
headers: {'content-type': 'application/json'},
data: {
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
billing_group_id: '',
client_state: '',
command_id: '',
connection_id: '',
custom_headers: [{name: '', value: ''}],
from: '',
from_display_name: '',
link_to: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"answering_machine_detection":"","answering_machine_detection_config":{"after_greeting_silence_millis":0,"between_words_silence_millis":0,"greeting_duration_millis":0,"greeting_silence_duration_millis":0,"greeting_total_analysis_time_millis":0,"initial_silence_millis":0,"maximum_number_of_words":0,"maximum_word_length_millis":0,"silence_threshold":0,"total_analysis_time_millis":0},"audio_url":"","billing_group_id":"","client_state":"","command_id":"","connection_id":"","custom_headers":[{"name":"","value":""}],"from":"","from_display_name":"","link_to":"","media_name":"","sip_auth_password":"","sip_auth_username":"","time_limit_secs":0,"timeout_secs":0,"to":"","webhook_url":"","webhook_url_method":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "answering_machine_detection": "",\n "answering_machine_detection_config": {\n "after_greeting_silence_millis": 0,\n "between_words_silence_millis": 0,\n "greeting_duration_millis": 0,\n "greeting_silence_duration_millis": 0,\n "greeting_total_analysis_time_millis": 0,\n "initial_silence_millis": 0,\n "maximum_number_of_words": 0,\n "maximum_word_length_millis": 0,\n "silence_threshold": 0,\n "total_analysis_time_millis": 0\n },\n "audio_url": "",\n "billing_group_id": "",\n "client_state": "",\n "command_id": "",\n "connection_id": "",\n "custom_headers": [\n {\n "name": "",\n "value": ""\n }\n ],\n "from": "",\n "from_display_name": "",\n "link_to": "",\n "media_name": "",\n "sip_auth_password": "",\n "sip_auth_username": "",\n "time_limit_secs": 0,\n "timeout_secs": 0,\n "to": "",\n "webhook_url": "",\n "webhook_url_method": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
billing_group_id: '',
client_state: '',
command_id: '',
connection_id: '',
custom_headers: [{name: '', value: ''}],
from: '',
from_display_name: '',
link_to: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls',
headers: {'content-type': 'application/json'},
body: {
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
billing_group_id: '',
client_state: '',
command_id: '',
connection_id: '',
custom_headers: [{name: '', value: ''}],
from: '',
from_display_name: '',
link_to: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
billing_group_id: '',
client_state: '',
command_id: '',
connection_id: '',
custom_headers: [
{
name: '',
value: ''
}
],
from: '',
from_display_name: '',
link_to: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls',
headers: {'content-type': 'application/json'},
data: {
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
billing_group_id: '',
client_state: '',
command_id: '',
connection_id: '',
custom_headers: [{name: '', value: ''}],
from: '',
from_display_name: '',
link_to: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"answering_machine_detection":"","answering_machine_detection_config":{"after_greeting_silence_millis":0,"between_words_silence_millis":0,"greeting_duration_millis":0,"greeting_silence_duration_millis":0,"greeting_total_analysis_time_millis":0,"initial_silence_millis":0,"maximum_number_of_words":0,"maximum_word_length_millis":0,"silence_threshold":0,"total_analysis_time_millis":0},"audio_url":"","billing_group_id":"","client_state":"","command_id":"","connection_id":"","custom_headers":[{"name":"","value":""}],"from":"","from_display_name":"","link_to":"","media_name":"","sip_auth_password":"","sip_auth_username":"","time_limit_secs":0,"timeout_secs":0,"to":"","webhook_url":"","webhook_url_method":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"answering_machine_detection": @"",
@"answering_machine_detection_config": @{ @"after_greeting_silence_millis": @0, @"between_words_silence_millis": @0, @"greeting_duration_millis": @0, @"greeting_silence_duration_millis": @0, @"greeting_total_analysis_time_millis": @0, @"initial_silence_millis": @0, @"maximum_number_of_words": @0, @"maximum_word_length_millis": @0, @"silence_threshold": @0, @"total_analysis_time_millis": @0 },
@"audio_url": @"",
@"billing_group_id": @"",
@"client_state": @"",
@"command_id": @"",
@"connection_id": @"",
@"custom_headers": @[ @{ @"name": @"", @"value": @"" } ],
@"from": @"",
@"from_display_name": @"",
@"link_to": @"",
@"media_name": @"",
@"sip_auth_password": @"",
@"sip_auth_username": @"",
@"time_limit_secs": @0,
@"timeout_secs": @0,
@"to": @"",
@"webhook_url": @"",
@"webhook_url_method": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls",
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([
'answering_machine_detection' => '',
'answering_machine_detection_config' => [
'after_greeting_silence_millis' => 0,
'between_words_silence_millis' => 0,
'greeting_duration_millis' => 0,
'greeting_silence_duration_millis' => 0,
'greeting_total_analysis_time_millis' => 0,
'initial_silence_millis' => 0,
'maximum_number_of_words' => 0,
'maximum_word_length_millis' => 0,
'silence_threshold' => 0,
'total_analysis_time_millis' => 0
],
'audio_url' => '',
'billing_group_id' => '',
'client_state' => '',
'command_id' => '',
'connection_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'from' => '',
'from_display_name' => '',
'link_to' => '',
'media_name' => '',
'sip_auth_password' => '',
'sip_auth_username' => '',
'time_limit_secs' => 0,
'timeout_secs' => 0,
'to' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls', [
'body' => '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'answering_machine_detection' => '',
'answering_machine_detection_config' => [
'after_greeting_silence_millis' => 0,
'between_words_silence_millis' => 0,
'greeting_duration_millis' => 0,
'greeting_silence_duration_millis' => 0,
'greeting_total_analysis_time_millis' => 0,
'initial_silence_millis' => 0,
'maximum_number_of_words' => 0,
'maximum_word_length_millis' => 0,
'silence_threshold' => 0,
'total_analysis_time_millis' => 0
],
'audio_url' => '',
'billing_group_id' => '',
'client_state' => '',
'command_id' => '',
'connection_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'from' => '',
'from_display_name' => '',
'link_to' => '',
'media_name' => '',
'sip_auth_password' => '',
'sip_auth_username' => '',
'time_limit_secs' => 0,
'timeout_secs' => 0,
'to' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'answering_machine_detection' => '',
'answering_machine_detection_config' => [
'after_greeting_silence_millis' => 0,
'between_words_silence_millis' => 0,
'greeting_duration_millis' => 0,
'greeting_silence_duration_millis' => 0,
'greeting_total_analysis_time_millis' => 0,
'initial_silence_millis' => 0,
'maximum_number_of_words' => 0,
'maximum_word_length_millis' => 0,
'silence_threshold' => 0,
'total_analysis_time_millis' => 0
],
'audio_url' => '',
'billing_group_id' => '',
'client_state' => '',
'command_id' => '',
'connection_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'from' => '',
'from_display_name' => '',
'link_to' => '',
'media_name' => '',
'sip_auth_password' => '',
'sip_auth_username' => '',
'time_limit_secs' => 0,
'timeout_secs' => 0,
'to' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls"
payload = {
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls"
payload <- "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls")
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 \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls') do |req|
req.body = "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"billing_group_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"connection_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"link_to\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls";
let payload = json!({
"answering_machine_detection": "",
"answering_machine_detection_config": json!({
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
}),
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": (
json!({
"name": "",
"value": ""
})
),
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls \
--header 'content-type: application/json' \
--data '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}'
echo '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}' | \
http POST {{baseUrl}}/calls \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "answering_machine_detection": "",\n "answering_machine_detection_config": {\n "after_greeting_silence_millis": 0,\n "between_words_silence_millis": 0,\n "greeting_duration_millis": 0,\n "greeting_silence_duration_millis": 0,\n "greeting_total_analysis_time_millis": 0,\n "initial_silence_millis": 0,\n "maximum_number_of_words": 0,\n "maximum_word_length_millis": 0,\n "silence_threshold": 0,\n "total_analysis_time_millis": 0\n },\n "audio_url": "",\n "billing_group_id": "",\n "client_state": "",\n "command_id": "",\n "connection_id": "",\n "custom_headers": [\n {\n "name": "",\n "value": ""\n }\n ],\n "from": "",\n "from_display_name": "",\n "link_to": "",\n "media_name": "",\n "sip_auth_password": "",\n "sip_auth_username": "",\n "time_limit_secs": 0,\n "timeout_secs": 0,\n "to": "",\n "webhook_url": "",\n "webhook_url_method": ""\n}' \
--output-document \
- {{baseUrl}}/calls
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"answering_machine_detection": "",
"answering_machine_detection_config": [
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
],
"audio_url": "",
"billing_group_id": "",
"client_state": "",
"command_id": "",
"connection_id": "",
"custom_headers": [
[
"name": "",
"value": ""
]
],
"from": "",
"from_display_name": "",
"link_to": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ",
"call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
"call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
"is_alive": false,
"record_type": "call"
}
}
POST
Enqueue call
{{baseUrl}}/calls/:call_control_id/actions/enqueue
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/enqueue");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/enqueue" {:content-type :json
:form-params {:client_state ""
:command_id ""
:max_size 0
:max_wait_time_secs 0
:queue_name ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/enqueue"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/enqueue"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/enqueue");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/enqueue"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/enqueue HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 108
{
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/enqueue")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/enqueue"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/enqueue")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/enqueue")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: '',
max_size: 0,
max_wait_time_secs: 0,
queue_name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/enqueue');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/enqueue',
headers: {'content-type': 'application/json'},
data: {
client_state: '',
command_id: '',
max_size: 0,
max_wait_time_secs: 0,
queue_name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/enqueue';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","max_size":0,"max_wait_time_secs":0,"queue_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/enqueue',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": "",\n "max_size": 0,\n "max_wait_time_secs": 0,\n "queue_name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/enqueue")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/enqueue',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
client_state: '',
command_id: '',
max_size: 0,
max_wait_time_secs: 0,
queue_name: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/enqueue',
headers: {'content-type': 'application/json'},
body: {
client_state: '',
command_id: '',
max_size: 0,
max_wait_time_secs: 0,
queue_name: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/enqueue');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: '',
max_size: 0,
max_wait_time_secs: 0,
queue_name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/enqueue',
headers: {'content-type': 'application/json'},
data: {
client_state: '',
command_id: '',
max_size: 0,
max_wait_time_secs: 0,
queue_name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/enqueue';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","max_size":0,"max_wait_time_secs":0,"queue_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"",
@"max_size": @0,
@"max_wait_time_secs": @0,
@"queue_name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/enqueue"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/enqueue" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/enqueue",
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([
'client_state' => '',
'command_id' => '',
'max_size' => 0,
'max_wait_time_secs' => 0,
'queue_name' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/enqueue', [
'body' => '{
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/enqueue');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => '',
'max_size' => 0,
'max_wait_time_secs' => 0,
'queue_name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => '',
'max_size' => 0,
'max_wait_time_secs' => 0,
'queue_name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/enqueue');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/enqueue' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/enqueue' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/enqueue", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/enqueue"
payload = {
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/enqueue"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/enqueue")
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 \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/enqueue') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"max_size\": 0,\n \"max_wait_time_secs\": 0,\n \"queue_name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/enqueue";
let payload = json!({
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/enqueue \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
}'
echo '{
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/enqueue \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": "",\n "max_size": 0,\n "max_wait_time_secs": 0,\n "queue_name": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/enqueue
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": "",
"max_size": 0,
"max_wait_time_secs": 0,
"queue_name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/enqueue")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Forking start
{{baseUrl}}/calls/:call_control_id/actions/fork_start
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/fork_start");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/fork_start" {:content-type :json
:form-params {:client_state ""
:command_id ""
:rx ""
:stream_type ""
:target ""
:tx ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/fork_start"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/fork_start"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/fork_start");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/fork_start"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/fork_start HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 105
{
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/fork_start")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/fork_start"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/fork_start")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/fork_start")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: '',
rx: '',
stream_type: '',
target: '',
tx: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/fork_start');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/fork_start',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: '', rx: '', stream_type: '', target: '', tx: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/fork_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","rx":"","stream_type":"","target":"","tx":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/fork_start',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": "",\n "rx": "",\n "stream_type": "",\n "target": "",\n "tx": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/fork_start")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/fork_start',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: '', rx: '', stream_type: '', target: '', tx: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/fork_start',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: '', rx: '', stream_type: '', target: '', tx: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/fork_start');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: '',
rx: '',
stream_type: '',
target: '',
tx: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/fork_start',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: '', rx: '', stream_type: '', target: '', tx: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/fork_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","rx":"","stream_type":"","target":"","tx":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"",
@"rx": @"",
@"stream_type": @"",
@"target": @"",
@"tx": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/fork_start"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/fork_start" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/fork_start",
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([
'client_state' => '',
'command_id' => '',
'rx' => '',
'stream_type' => '',
'target' => '',
'tx' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/fork_start', [
'body' => '{
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/fork_start');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => '',
'rx' => '',
'stream_type' => '',
'target' => '',
'tx' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => '',
'rx' => '',
'stream_type' => '',
'target' => '',
'tx' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/fork_start');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/fork_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/fork_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/fork_start", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/fork_start"
payload = {
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/fork_start"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/fork_start")
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 \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/fork_start') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"rx\": \"\",\n \"stream_type\": \"\",\n \"target\": \"\",\n \"tx\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/fork_start";
let payload = json!({
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/fork_start \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
}'
echo '{
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/fork_start \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": "",\n "rx": "",\n "stream_type": "",\n "target": "",\n "tx": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/fork_start
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": "",
"rx": "",
"stream_type": "",
"target": "",
"tx": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/fork_start")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Forking stop
{{baseUrl}}/calls/:call_control_id/actions/fork_stop
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/fork_stop");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/fork_stop" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/fork_stop"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/fork_stop"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/fork_stop");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/fork_stop"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/fork_stop HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/fork_stop")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/fork_stop"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/fork_stop")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/fork_stop")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/fork_stop');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/fork_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/fork_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/fork_stop',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/fork_stop")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/fork_stop',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/fork_stop',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/fork_stop');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/fork_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/fork_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/fork_stop"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/fork_stop" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/fork_stop",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/fork_stop', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/fork_stop');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/fork_stop');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/fork_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/fork_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/fork_stop", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/fork_stop"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/fork_stop"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/fork_stop")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/fork_stop') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/fork_stop";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/fork_stop \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/fork_stop \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/fork_stop
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/fork_stop")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Gather stop
{{baseUrl}}/calls/:call_control_id/actions/gather_stop
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/gather_stop");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/gather_stop" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/gather_stop"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/gather_stop"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/gather_stop");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/gather_stop"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/gather_stop HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/gather_stop")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/gather_stop"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/gather_stop")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/gather_stop")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_stop');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/gather_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_stop',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/gather_stop")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/gather_stop',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_stop',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_stop');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/gather_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/gather_stop"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/gather_stop" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/gather_stop",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_stop', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/gather_stop');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/gather_stop');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/gather_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/gather_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/gather_stop", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/gather_stop"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/gather_stop"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/gather_stop")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/gather_stop') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/gather_stop";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/gather_stop \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/gather_stop \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/gather_stop
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/gather_stop")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Gather using audio
{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio
QUERY PARAMS
call_control_id
BODY json
{
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio" {:content-type :json
:form-params {:audio_url ""
:client_state ""
:command_id ""
:inter_digit_timeout_millis 0
:invalid_audio_url ""
:invalid_media_name ""
:maximum_digits 0
:maximum_tries 0
:media_name ""
:minimum_digits 0
:terminating_digit ""
:timeout_millis 0
:valid_digits ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio"),
Content = new StringContent("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio"
payload := strings.NewReader("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/gather_using_audio HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 313
{
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio")
.setHeader("content-type", "application/json")
.setBody("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio")
.header("content-type", "application/json")
.body("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}")
.asString();
const data = JSON.stringify({
audio_url: '',
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_audio_url: '',
invalid_media_name: '',
maximum_digits: 0,
maximum_tries: 0,
media_name: '',
minimum_digits: 0,
terminating_digit: '',
timeout_millis: 0,
valid_digits: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio',
headers: {'content-type': 'application/json'},
data: {
audio_url: '',
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_audio_url: '',
invalid_media_name: '',
maximum_digits: 0,
maximum_tries: 0,
media_name: '',
minimum_digits: 0,
terminating_digit: '',
timeout_millis: 0,
valid_digits: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio_url":"","client_state":"","command_id":"","inter_digit_timeout_millis":0,"invalid_audio_url":"","invalid_media_name":"","maximum_digits":0,"maximum_tries":0,"media_name":"","minimum_digits":0,"terminating_digit":"","timeout_millis":0,"valid_digits":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "audio_url": "",\n "client_state": "",\n "command_id": "",\n "inter_digit_timeout_millis": 0,\n "invalid_audio_url": "",\n "invalid_media_name": "",\n "maximum_digits": 0,\n "maximum_tries": 0,\n "media_name": "",\n "minimum_digits": 0,\n "terminating_digit": "",\n "timeout_millis": 0,\n "valid_digits": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/gather_using_audio',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
audio_url: '',
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_audio_url: '',
invalid_media_name: '',
maximum_digits: 0,
maximum_tries: 0,
media_name: '',
minimum_digits: 0,
terminating_digit: '',
timeout_millis: 0,
valid_digits: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio',
headers: {'content-type': 'application/json'},
body: {
audio_url: '',
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_audio_url: '',
invalid_media_name: '',
maximum_digits: 0,
maximum_tries: 0,
media_name: '',
minimum_digits: 0,
terminating_digit: '',
timeout_millis: 0,
valid_digits: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
audio_url: '',
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_audio_url: '',
invalid_media_name: '',
maximum_digits: 0,
maximum_tries: 0,
media_name: '',
minimum_digits: 0,
terminating_digit: '',
timeout_millis: 0,
valid_digits: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio',
headers: {'content-type': 'application/json'},
data: {
audio_url: '',
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_audio_url: '',
invalid_media_name: '',
maximum_digits: 0,
maximum_tries: 0,
media_name: '',
minimum_digits: 0,
terminating_digit: '',
timeout_millis: 0,
valid_digits: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio_url":"","client_state":"","command_id":"","inter_digit_timeout_millis":0,"invalid_audio_url":"","invalid_media_name":"","maximum_digits":0,"maximum_tries":0,"media_name":"","minimum_digits":0,"terminating_digit":"","timeout_millis":0,"valid_digits":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"audio_url": @"",
@"client_state": @"",
@"command_id": @"",
@"inter_digit_timeout_millis": @0,
@"invalid_audio_url": @"",
@"invalid_media_name": @"",
@"maximum_digits": @0,
@"maximum_tries": @0,
@"media_name": @"",
@"minimum_digits": @0,
@"terminating_digit": @"",
@"timeout_millis": @0,
@"valid_digits": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio",
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([
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'inter_digit_timeout_millis' => 0,
'invalid_audio_url' => '',
'invalid_media_name' => '',
'maximum_digits' => 0,
'maximum_tries' => 0,
'media_name' => '',
'minimum_digits' => 0,
'terminating_digit' => '',
'timeout_millis' => 0,
'valid_digits' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio', [
'body' => '{
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'inter_digit_timeout_millis' => 0,
'invalid_audio_url' => '',
'invalid_media_name' => '',
'maximum_digits' => 0,
'maximum_tries' => 0,
'media_name' => '',
'minimum_digits' => 0,
'terminating_digit' => '',
'timeout_millis' => 0,
'valid_digits' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'inter_digit_timeout_millis' => 0,
'invalid_audio_url' => '',
'invalid_media_name' => '',
'maximum_digits' => 0,
'maximum_tries' => 0,
'media_name' => '',
'minimum_digits' => 0,
'terminating_digit' => '',
'timeout_millis' => 0,
'valid_digits' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/gather_using_audio", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio"
payload = {
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio"
payload <- "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio")
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 \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/gather_using_audio') do |req|
req.body = "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_audio_url\": \"\",\n \"invalid_media_name\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"media_name\": \"\",\n \"minimum_digits\": 0,\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio";
let payload = json!({
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/gather_using_audio \
--header 'content-type: application/json' \
--data '{
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
}'
echo '{
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/gather_using_audio \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "audio_url": "",\n "client_state": "",\n "command_id": "",\n "inter_digit_timeout_millis": 0,\n "invalid_audio_url": "",\n "invalid_media_name": "",\n "maximum_digits": 0,\n "maximum_tries": 0,\n "media_name": "",\n "minimum_digits": 0,\n "terminating_digit": "",\n "timeout_millis": 0,\n "valid_digits": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/gather_using_audio
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"audio_url": "",
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_audio_url": "",
"invalid_media_name": "",
"maximum_digits": 0,
"maximum_tries": 0,
"media_name": "",
"minimum_digits": 0,
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/gather_using_audio")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Gather using speak
{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak" {:content-type :json
:form-params {:client_state ""
:command_id ""
:inter_digit_timeout_millis 0
:invalid_payload ""
:language ""
:maximum_digits 0
:maximum_tries 0
:minimum_digits 0
:payload ""
:payload_type ""
:service_level ""
:terminating_digit ""
:timeout_millis 0
:valid_digits ""
:voice ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/gather_using_speak HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 339
{
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_payload: '',
language: '',
maximum_digits: 0,
maximum_tries: 0,
minimum_digits: 0,
payload: '',
payload_type: '',
service_level: '',
terminating_digit: '',
timeout_millis: 0,
valid_digits: '',
voice: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak',
headers: {'content-type': 'application/json'},
data: {
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_payload: '',
language: '',
maximum_digits: 0,
maximum_tries: 0,
minimum_digits: 0,
payload: '',
payload_type: '',
service_level: '',
terminating_digit: '',
timeout_millis: 0,
valid_digits: '',
voice: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","inter_digit_timeout_millis":0,"invalid_payload":"","language":"","maximum_digits":0,"maximum_tries":0,"minimum_digits":0,"payload":"","payload_type":"","service_level":"","terminating_digit":"","timeout_millis":0,"valid_digits":"","voice":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": "",\n "inter_digit_timeout_millis": 0,\n "invalid_payload": "",\n "language": "",\n "maximum_digits": 0,\n "maximum_tries": 0,\n "minimum_digits": 0,\n "payload": "",\n "payload_type": "",\n "service_level": "",\n "terminating_digit": "",\n "timeout_millis": 0,\n "valid_digits": "",\n "voice": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/gather_using_speak',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_payload: '',
language: '',
maximum_digits: 0,
maximum_tries: 0,
minimum_digits: 0,
payload: '',
payload_type: '',
service_level: '',
terminating_digit: '',
timeout_millis: 0,
valid_digits: '',
voice: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak',
headers: {'content-type': 'application/json'},
body: {
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_payload: '',
language: '',
maximum_digits: 0,
maximum_tries: 0,
minimum_digits: 0,
payload: '',
payload_type: '',
service_level: '',
terminating_digit: '',
timeout_millis: 0,
valid_digits: '',
voice: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_payload: '',
language: '',
maximum_digits: 0,
maximum_tries: 0,
minimum_digits: 0,
payload: '',
payload_type: '',
service_level: '',
terminating_digit: '',
timeout_millis: 0,
valid_digits: '',
voice: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak',
headers: {'content-type': 'application/json'},
data: {
client_state: '',
command_id: '',
inter_digit_timeout_millis: 0,
invalid_payload: '',
language: '',
maximum_digits: 0,
maximum_tries: 0,
minimum_digits: 0,
payload: '',
payload_type: '',
service_level: '',
terminating_digit: '',
timeout_millis: 0,
valid_digits: '',
voice: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","inter_digit_timeout_millis":0,"invalid_payload":"","language":"","maximum_digits":0,"maximum_tries":0,"minimum_digits":0,"payload":"","payload_type":"","service_level":"","terminating_digit":"","timeout_millis":0,"valid_digits":"","voice":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"",
@"inter_digit_timeout_millis": @0,
@"invalid_payload": @"",
@"language": @"",
@"maximum_digits": @0,
@"maximum_tries": @0,
@"minimum_digits": @0,
@"payload": @"",
@"payload_type": @"",
@"service_level": @"",
@"terminating_digit": @"",
@"timeout_millis": @0,
@"valid_digits": @"",
@"voice": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak",
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([
'client_state' => '',
'command_id' => '',
'inter_digit_timeout_millis' => 0,
'invalid_payload' => '',
'language' => '',
'maximum_digits' => 0,
'maximum_tries' => 0,
'minimum_digits' => 0,
'payload' => '',
'payload_type' => '',
'service_level' => '',
'terminating_digit' => '',
'timeout_millis' => 0,
'valid_digits' => '',
'voice' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak', [
'body' => '{
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => '',
'inter_digit_timeout_millis' => 0,
'invalid_payload' => '',
'language' => '',
'maximum_digits' => 0,
'maximum_tries' => 0,
'minimum_digits' => 0,
'payload' => '',
'payload_type' => '',
'service_level' => '',
'terminating_digit' => '',
'timeout_millis' => 0,
'valid_digits' => '',
'voice' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => '',
'inter_digit_timeout_millis' => 0,
'invalid_payload' => '',
'language' => '',
'maximum_digits' => 0,
'maximum_tries' => 0,
'minimum_digits' => 0,
'payload' => '',
'payload_type' => '',
'service_level' => '',
'terminating_digit' => '',
'timeout_millis' => 0,
'valid_digits' => '',
'voice' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/gather_using_speak", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak"
payload = {
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak")
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 \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/gather_using_speak') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"inter_digit_timeout_millis\": 0,\n \"invalid_payload\": \"\",\n \"language\": \"\",\n \"maximum_digits\": 0,\n \"maximum_tries\": 0,\n \"minimum_digits\": 0,\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"terminating_digit\": \"\",\n \"timeout_millis\": 0,\n \"valid_digits\": \"\",\n \"voice\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak";
let payload = json!({
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/gather_using_speak \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
}'
echo '{
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/gather_using_speak \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": "",\n "inter_digit_timeout_millis": 0,\n "invalid_payload": "",\n "language": "",\n "maximum_digits": 0,\n "maximum_tries": 0,\n "minimum_digits": 0,\n "payload": "",\n "payload_type": "",\n "service_level": "",\n "terminating_digit": "",\n "timeout_millis": 0,\n "valid_digits": "",\n "voice": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/gather_using_speak
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": "",
"inter_digit_timeout_millis": 0,
"invalid_payload": "",
"language": "",
"maximum_digits": 0,
"maximum_tries": 0,
"minimum_digits": 0,
"payload": "",
"payload_type": "",
"service_level": "",
"terminating_digit": "",
"timeout_millis": 0,
"valid_digits": "",
"voice": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/gather_using_speak")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Hangup call
{{baseUrl}}/calls/:call_control_id/actions/hangup
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/hangup");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/hangup" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/hangup"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/hangup"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/hangup");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/hangup"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/hangup HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/hangup")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/hangup"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/hangup")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/hangup")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/hangup');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/hangup',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/hangup';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/hangup',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/hangup")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/hangup',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/hangup',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/hangup');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/hangup',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/hangup';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/hangup"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/hangup" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/hangup",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/hangup', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/hangup');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/hangup');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/hangup' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/hangup' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/hangup", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/hangup"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/hangup"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/hangup")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/hangup') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/hangup";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/hangup \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/hangup \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/hangup
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/hangup")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Play audio URL
{{baseUrl}}/calls/:call_control_id/actions/playback_start
QUERY PARAMS
call_control_id
BODY json
{
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/playback_start");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/playback_start" {:content-type :json
:form-params {:audio_url ""
:client_state ""
:command_id ""
:loop ""
:media_name ""
:overlay false
:stop ""
:target_legs ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/playback_start"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/playback_start"),
Content = new StringContent("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/playback_start");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/playback_start"
payload := strings.NewReader("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/playback_start HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 152
{
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/playback_start")
.setHeader("content-type", "application/json")
.setBody("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/playback_start"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/playback_start")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/playback_start")
.header("content-type", "application/json")
.body("{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}")
.asString();
const data = JSON.stringify({
audio_url: '',
client_state: '',
command_id: '',
loop: '',
media_name: '',
overlay: false,
stop: '',
target_legs: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/playback_start');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/playback_start',
headers: {'content-type': 'application/json'},
data: {
audio_url: '',
client_state: '',
command_id: '',
loop: '',
media_name: '',
overlay: false,
stop: '',
target_legs: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/playback_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio_url":"","client_state":"","command_id":"","loop":"","media_name":"","overlay":false,"stop":"","target_legs":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/playback_start',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "audio_url": "",\n "client_state": "",\n "command_id": "",\n "loop": "",\n "media_name": "",\n "overlay": false,\n "stop": "",\n "target_legs": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/playback_start")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/playback_start',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
audio_url: '',
client_state: '',
command_id: '',
loop: '',
media_name: '',
overlay: false,
stop: '',
target_legs: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/playback_start',
headers: {'content-type': 'application/json'},
body: {
audio_url: '',
client_state: '',
command_id: '',
loop: '',
media_name: '',
overlay: false,
stop: '',
target_legs: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/playback_start');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
audio_url: '',
client_state: '',
command_id: '',
loop: '',
media_name: '',
overlay: false,
stop: '',
target_legs: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/playback_start',
headers: {'content-type': 'application/json'},
data: {
audio_url: '',
client_state: '',
command_id: '',
loop: '',
media_name: '',
overlay: false,
stop: '',
target_legs: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/playback_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio_url":"","client_state":"","command_id":"","loop":"","media_name":"","overlay":false,"stop":"","target_legs":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"audio_url": @"",
@"client_state": @"",
@"command_id": @"",
@"loop": @"",
@"media_name": @"",
@"overlay": @NO,
@"stop": @"",
@"target_legs": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/playback_start"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/playback_start" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/playback_start",
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([
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'loop' => '',
'media_name' => '',
'overlay' => null,
'stop' => '',
'target_legs' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/playback_start', [
'body' => '{
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/playback_start');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'loop' => '',
'media_name' => '',
'overlay' => null,
'stop' => '',
'target_legs' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'loop' => '',
'media_name' => '',
'overlay' => null,
'stop' => '',
'target_legs' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/playback_start');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/playback_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/playback_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/playback_start", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/playback_start"
payload = {
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": False,
"stop": "",
"target_legs": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/playback_start"
payload <- "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/playback_start")
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 \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/playback_start') do |req|
req.body = "{\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"loop\": \"\",\n \"media_name\": \"\",\n \"overlay\": false,\n \"stop\": \"\",\n \"target_legs\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/playback_start";
let payload = json!({
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/playback_start \
--header 'content-type: application/json' \
--data '{
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
}'
echo '{
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/playback_start \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "audio_url": "",\n "client_state": "",\n "command_id": "",\n "loop": "",\n "media_name": "",\n "overlay": false,\n "stop": "",\n "target_legs": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/playback_start
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"audio_url": "",
"client_state": "",
"command_id": "",
"loop": "",
"media_name": "",
"overlay": false,
"stop": "",
"target_legs": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/playback_start")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Record pause
{{baseUrl}}/calls/:call_control_id/actions/record_pause
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/record_pause");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/record_pause" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/record_pause"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/record_pause"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/record_pause");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/record_pause"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/record_pause HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/record_pause")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/record_pause"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/record_pause")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/record_pause")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_pause');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_pause',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/record_pause';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/record_pause',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/record_pause")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/record_pause',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_pause',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_pause');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_pause',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/record_pause';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/record_pause"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/record_pause" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/record_pause",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_pause', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/record_pause');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/record_pause');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/record_pause' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/record_pause' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/record_pause", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/record_pause"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/record_pause"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/record_pause")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/record_pause') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/record_pause";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/record_pause \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/record_pause \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/record_pause
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/record_pause")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Record resume
{{baseUrl}}/calls/:call_control_id/actions/record_resume
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/record_resume");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/record_resume" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/record_resume"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/record_resume"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/record_resume");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/record_resume"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/record_resume HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/record_resume")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/record_resume"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/record_resume")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/record_resume")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_resume');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_resume',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/record_resume';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/record_resume',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/record_resume")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/record_resume',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_resume',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_resume');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_resume',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/record_resume';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/record_resume"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/record_resume" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/record_resume",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_resume', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/record_resume');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/record_resume');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/record_resume' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/record_resume' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/record_resume", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/record_resume"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/record_resume"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/record_resume")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/record_resume') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/record_resume";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/record_resume \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/record_resume \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/record_resume
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/record_resume")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Recording start
{{baseUrl}}/calls/:call_control_id/actions/record_start
QUERY PARAMS
call_control_id
BODY json
{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/record_start");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/record_start" {:content-type :json
:form-params {:channels ""
:client_state ""
:command_id ""
:format ""
:max_length 0
:play_beep false}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/record_start"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/record_start"),
Content = new StringContent("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/record_start");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/record_start"
payload := strings.NewReader("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/record_start HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 119
{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/record_start")
.setHeader("content-type", "application/json")
.setBody("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/record_start"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/record_start")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/record_start")
.header("content-type", "application/json")
.body("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}")
.asString();
const data = JSON.stringify({
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_start');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_start',
headers: {'content-type': 'application/json'},
data: {
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/record_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"channels":"","client_state":"","command_id":"","format":"","max_length":0,"play_beep":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/record_start',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "channels": "",\n "client_state": "",\n "command_id": "",\n "format": "",\n "max_length": 0,\n "play_beep": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/record_start")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/record_start',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_start',
headers: {'content-type': 'application/json'},
body: {
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_start');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_start',
headers: {'content-type': 'application/json'},
data: {
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/record_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"channels":"","client_state":"","command_id":"","format":"","max_length":0,"play_beep":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"channels": @"",
@"client_state": @"",
@"command_id": @"",
@"format": @"",
@"max_length": @0,
@"play_beep": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/record_start"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/record_start" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/record_start",
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([
'channels' => '',
'client_state' => '',
'command_id' => '',
'format' => '',
'max_length' => 0,
'play_beep' => null
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_start', [
'body' => '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/record_start');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'channels' => '',
'client_state' => '',
'command_id' => '',
'format' => '',
'max_length' => 0,
'play_beep' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'channels' => '',
'client_state' => '',
'command_id' => '',
'format' => '',
'max_length' => 0,
'play_beep' => null
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/record_start');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/record_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/record_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/record_start", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/record_start"
payload = {
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/record_start"
payload <- "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/record_start")
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 \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/record_start') do |req|
req.body = "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/record_start";
let payload = json!({
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/record_start \
--header 'content-type: application/json' \
--data '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}'
echo '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/record_start \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "channels": "",\n "client_state": "",\n "command_id": "",\n "format": "",\n "max_length": 0,\n "play_beep": false\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/record_start
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/record_start")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Recording stop
{{baseUrl}}/calls/:call_control_id/actions/record_stop
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/record_stop");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/record_stop" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/record_stop"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/record_stop"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/record_stop");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/record_stop"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/record_stop HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/record_stop")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/record_stop"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/record_stop")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/record_stop")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_stop');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/record_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/record_stop',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/record_stop")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/record_stop',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_stop',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_stop');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/record_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/record_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/record_stop"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/record_stop" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/record_stop",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/record_stop', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/record_stop');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/record_stop');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/record_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/record_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/record_stop", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/record_stop"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/record_stop"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/record_stop")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/record_stop') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/record_stop";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/record_stop \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/record_stop \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/record_stop
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/record_stop")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Reject a call
{{baseUrl}}/calls/:call_control_id/actions/reject
QUERY PARAMS
call_control_id
BODY json
{
"cause": "",
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/reject");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/reject" {:content-type :json
:form-params {:cause ""
:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/reject"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/reject"),
Content = new StringContent("{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/reject");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/reject"
payload := strings.NewReader("{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/reject HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 59
{
"cause": "",
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/reject")
.setHeader("content-type", "application/json")
.setBody("{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/reject"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/reject")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/reject")
.header("content-type", "application/json")
.body("{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
cause: '',
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/reject');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/reject',
headers: {'content-type': 'application/json'},
data: {cause: '', client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/reject';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"cause":"","client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/reject',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "cause": "",\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/reject")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/reject',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({cause: '', client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/reject',
headers: {'content-type': 'application/json'},
body: {cause: '', client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/reject');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
cause: '',
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/reject',
headers: {'content-type': 'application/json'},
data: {cause: '', client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/reject';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"cause":"","client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"cause": @"",
@"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/reject"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/reject" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/reject",
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([
'cause' => '',
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/reject', [
'body' => '{
"cause": "",
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/reject');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'cause' => '',
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'cause' => '',
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/reject');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/reject' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"cause": "",
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/reject' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"cause": "",
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/reject", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/reject"
payload = {
"cause": "",
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/reject"
payload <- "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/reject")
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 \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/reject') do |req|
req.body = "{\n \"cause\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/reject";
let payload = json!({
"cause": "",
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/reject \
--header 'content-type: application/json' \
--data '{
"cause": "",
"client_state": "",
"command_id": ""
}'
echo '{
"cause": "",
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/reject \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "cause": "",\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/reject
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"cause": "",
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/reject")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Remove call from a queue
{{baseUrl}}/calls/:call_control_id/actions/leave_queue
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/leave_queue");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/leave_queue" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/leave_queue"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/leave_queue"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/leave_queue");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/leave_queue"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/leave_queue HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/leave_queue")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/leave_queue"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/leave_queue")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/leave_queue")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/leave_queue');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/leave_queue',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/leave_queue';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/leave_queue',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/leave_queue")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/leave_queue',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/leave_queue',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/leave_queue');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/leave_queue',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/leave_queue';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/leave_queue"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/leave_queue" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/leave_queue",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/leave_queue', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/leave_queue');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/leave_queue');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/leave_queue' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/leave_queue' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/leave_queue", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/leave_queue"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/leave_queue"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/leave_queue")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/leave_queue') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/leave_queue";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/leave_queue \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/leave_queue \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/leave_queue
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/leave_queue")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
SIP Refer a call
{{baseUrl}}/calls/:call_control_id/actions/refer
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/refer");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/refer" {:content-type :json
:form-params {:client_state ""
:command_id ""
:custom_headers [{:name ""
:value ""}]
:sip_address ""
:sip_auth_password ""
:sip_auth_username ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/refer"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/refer"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/refer");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/refer"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/refer HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 194
{
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/refer")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/refer"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/refer")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/refer")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: '',
custom_headers: [
{
name: '',
value: ''
}
],
sip_address: '',
sip_auth_password: '',
sip_auth_username: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/refer');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/refer',
headers: {'content-type': 'application/json'},
data: {
client_state: '',
command_id: '',
custom_headers: [{name: '', value: ''}],
sip_address: '',
sip_auth_password: '',
sip_auth_username: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/refer';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","custom_headers":[{"name":"","value":""}],"sip_address":"","sip_auth_password":"","sip_auth_username":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/refer',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": "",\n "custom_headers": [\n {\n "name": "",\n "value": ""\n }\n ],\n "sip_address": "",\n "sip_auth_password": "",\n "sip_auth_username": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/refer")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/refer',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
client_state: '',
command_id: '',
custom_headers: [{name: '', value: ''}],
sip_address: '',
sip_auth_password: '',
sip_auth_username: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/refer',
headers: {'content-type': 'application/json'},
body: {
client_state: '',
command_id: '',
custom_headers: [{name: '', value: ''}],
sip_address: '',
sip_auth_password: '',
sip_auth_username: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/refer');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: '',
custom_headers: [
{
name: '',
value: ''
}
],
sip_address: '',
sip_auth_password: '',
sip_auth_username: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/refer',
headers: {'content-type': 'application/json'},
data: {
client_state: '',
command_id: '',
custom_headers: [{name: '', value: ''}],
sip_address: '',
sip_auth_password: '',
sip_auth_username: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/refer';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","custom_headers":[{"name":"","value":""}],"sip_address":"","sip_auth_password":"","sip_auth_username":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"",
@"custom_headers": @[ @{ @"name": @"", @"value": @"" } ],
@"sip_address": @"",
@"sip_auth_password": @"",
@"sip_auth_username": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/refer"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/refer" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/refer",
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([
'client_state' => '',
'command_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'sip_address' => '',
'sip_auth_password' => '',
'sip_auth_username' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/refer', [
'body' => '{
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/refer');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'sip_address' => '',
'sip_auth_password' => '',
'sip_auth_username' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'sip_address' => '',
'sip_auth_password' => '',
'sip_auth_username' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/refer');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/refer' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/refer' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/refer", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/refer"
payload = {
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/refer"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/refer")
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 \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/refer') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"sip_address\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/refer";
let payload = json!({
"client_state": "",
"command_id": "",
"custom_headers": (
json!({
"name": "",
"value": ""
})
),
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/refer \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
}'
echo '{
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/refer \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": "",\n "custom_headers": [\n {\n "name": "",\n "value": ""\n }\n ],\n "sip_address": "",\n "sip_auth_password": "",\n "sip_auth_username": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/refer
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": "",
"custom_headers": [
[
"name": "",
"value": ""
]
],
"sip_address": "",
"sip_auth_password": "",
"sip_auth_username": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/refer")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Send DTMF
{{baseUrl}}/calls/:call_control_id/actions/send_dtmf
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf" {:content-type :json
:form-params {:client_state ""
:command_id ""
:digits ""
:duration_millis 0}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/send_dtmf"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/send_dtmf");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/send_dtmf HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 84
{
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/send_dtmf"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/send_dtmf")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/send_dtmf")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: '',
digits: '',
duration_millis: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: '', digits: '', duration_millis: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","digits":"","duration_millis":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": "",\n "digits": "",\n "duration_millis": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/send_dtmf")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/send_dtmf',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: '', digits: '', duration_millis: 0}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: '', digits: '', duration_millis: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: '',
digits: '',
duration_millis: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: '', digits: '', duration_millis: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","digits":"","duration_millis":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"",
@"digits": @"",
@"duration_millis": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/send_dtmf"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/send_dtmf",
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([
'client_state' => '',
'command_id' => '',
'digits' => '',
'duration_millis' => 0
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf', [
'body' => '{
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/send_dtmf');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => '',
'digits' => '',
'duration_millis' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => '',
'digits' => '',
'duration_millis' => 0
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/send_dtmf');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/send_dtmf' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/send_dtmf", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf"
payload = {
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/send_dtmf")
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 \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/send_dtmf') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"digits\": \"\",\n \"duration_millis\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf";
let payload = json!({
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/send_dtmf \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
}'
echo '{
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/send_dtmf \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": "",\n "digits": "",\n "duration_millis": 0\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/send_dtmf
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": "",
"digits": "",
"duration_millis": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/send_dtmf")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Speak text
{{baseUrl}}/calls/:call_control_id/actions/speak
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/speak");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/speak" {:content-type :json
:form-params {:client_state ""
:command_id ""
:language ""
:payload ""
:payload_type ""
:service_level ""
:stop ""
:voice ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/speak"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/speak"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/speak");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/speak"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/speak HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 153
{
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/speak")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/speak"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/speak")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/speak")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: '',
language: '',
payload: '',
payload_type: '',
service_level: '',
stop: '',
voice: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/speak');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/speak',
headers: {'content-type': 'application/json'},
data: {
client_state: '',
command_id: '',
language: '',
payload: '',
payload_type: '',
service_level: '',
stop: '',
voice: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/speak';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","language":"","payload":"","payload_type":"","service_level":"","stop":"","voice":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/speak',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": "",\n "language": "",\n "payload": "",\n "payload_type": "",\n "service_level": "",\n "stop": "",\n "voice": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/speak")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/speak',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
client_state: '',
command_id: '',
language: '',
payload: '',
payload_type: '',
service_level: '',
stop: '',
voice: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/speak',
headers: {'content-type': 'application/json'},
body: {
client_state: '',
command_id: '',
language: '',
payload: '',
payload_type: '',
service_level: '',
stop: '',
voice: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/speak');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: '',
language: '',
payload: '',
payload_type: '',
service_level: '',
stop: '',
voice: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/speak',
headers: {'content-type': 'application/json'},
data: {
client_state: '',
command_id: '',
language: '',
payload: '',
payload_type: '',
service_level: '',
stop: '',
voice: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/speak';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","language":"","payload":"","payload_type":"","service_level":"","stop":"","voice":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"",
@"language": @"",
@"payload": @"",
@"payload_type": @"",
@"service_level": @"",
@"stop": @"",
@"voice": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/speak"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/speak" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/speak",
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([
'client_state' => '',
'command_id' => '',
'language' => '',
'payload' => '',
'payload_type' => '',
'service_level' => '',
'stop' => '',
'voice' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/speak', [
'body' => '{
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/speak');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => '',
'language' => '',
'payload' => '',
'payload_type' => '',
'service_level' => '',
'stop' => '',
'voice' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => '',
'language' => '',
'payload' => '',
'payload_type' => '',
'service_level' => '',
'stop' => '',
'voice' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/speak');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/speak' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/speak' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/speak", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/speak"
payload = {
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/speak"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/speak")
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 \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/speak') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"service_level\": \"\",\n \"stop\": \"\",\n \"voice\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/speak";
let payload = json!({
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/speak \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
}'
echo '{
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/speak \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": "",\n "language": "",\n "payload": "",\n "payload_type": "",\n "service_level": "",\n "stop": "",\n "voice": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/speak
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"service_level": "",
"stop": "",
"voice": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/speak")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Stop audio playback
{{baseUrl}}/calls/:call_control_id/actions/playback_stop
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": "",
"stop": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/playback_stop");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/playback_stop" {:content-type :json
:form-params {:client_state ""
:command_id ""
:stop ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/playback_stop"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/playback_stop"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/playback_stop");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/playback_stop"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/playback_stop HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 58
{
"client_state": "",
"command_id": "",
"stop": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/playback_stop")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/playback_stop"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/playback_stop")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/playback_stop")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: '',
stop: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/playback_stop');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/playback_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: '', stop: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/playback_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","stop":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/playback_stop',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": "",\n "stop": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/playback_stop")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/playback_stop',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: '', stop: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/playback_stop',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: '', stop: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/playback_stop');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: '',
stop: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/playback_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: '', stop: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/playback_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","stop":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"",
@"stop": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/playback_stop"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/playback_stop" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/playback_stop",
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([
'client_state' => '',
'command_id' => '',
'stop' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/playback_stop', [
'body' => '{
"client_state": "",
"command_id": "",
"stop": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/playback_stop');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => '',
'stop' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => '',
'stop' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/playback_stop');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/playback_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"stop": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/playback_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"stop": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/playback_stop", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/playback_stop"
payload = {
"client_state": "",
"command_id": "",
"stop": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/playback_stop"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/playback_stop")
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 \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/playback_stop') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"stop\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/playback_stop";
let payload = json!({
"client_state": "",
"command_id": "",
"stop": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/playback_stop \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": "",
"stop": ""
}'
echo '{
"client_state": "",
"command_id": "",
"stop": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/playback_stop \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": "",\n "stop": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/playback_stop
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": "",
"stop": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/playback_stop")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Transcription start
{{baseUrl}}/calls/:call_control_id/actions/transcription_start
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": "",
"language": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/transcription_start");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/transcription_start" {:content-type :json
:form-params {:client_state ""
:command_id ""
:language ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/transcription_start"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/transcription_start"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/transcription_start");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/transcription_start"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/transcription_start HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 62
{
"client_state": "",
"command_id": "",
"language": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/transcription_start")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/transcription_start"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/transcription_start")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/transcription_start")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: '',
language: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/transcription_start');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transcription_start',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: '', language: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/transcription_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","language":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/transcription_start',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": "",\n "language": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/transcription_start")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/transcription_start',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: '', language: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transcription_start',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: '', language: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/transcription_start');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: '',
language: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transcription_start',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: '', language: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/transcription_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":"","language":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"",
@"language": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/transcription_start"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/transcription_start" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/transcription_start",
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([
'client_state' => '',
'command_id' => '',
'language' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/transcription_start', [
'body' => '{
"client_state": "",
"command_id": "",
"language": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/transcription_start');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => '',
'language' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => '',
'language' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/transcription_start');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/transcription_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"language": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/transcription_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": "",
"language": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/transcription_start", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/transcription_start"
payload = {
"client_state": "",
"command_id": "",
"language": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/transcription_start"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/transcription_start")
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 \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/transcription_start') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"language\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/transcription_start";
let payload = json!({
"client_state": "",
"command_id": "",
"language": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/transcription_start \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": "",
"language": ""
}'
echo '{
"client_state": "",
"command_id": "",
"language": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/transcription_start \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": "",\n "language": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/transcription_start
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": "",
"language": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/transcription_start")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Transcription stop
{{baseUrl}}/calls/:call_control_id/actions/transcription_stop
QUERY PARAMS
call_control_id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/transcription_stop"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/transcription_stop");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/transcription_stop HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/transcription_stop"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/transcription_stop")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/transcription_stop")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/transcription_stop")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/transcription_stop',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/transcription_stop"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/transcription_stop",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/transcription_stop');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/transcription_stop');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/transcription_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/transcription_stop", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/transcription_stop")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/transcription_stop') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/transcription_stop \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/transcription_stop \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/transcription_stop
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/transcription_stop")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Transfer call
{{baseUrl}}/calls/:call_control_id/actions/transfer
QUERY PARAMS
call_control_id
BODY json
{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id/actions/transfer");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/calls/:call_control_id/actions/transfer" {:content-type :json
:form-params {:answering_machine_detection ""
:answering_machine_detection_config {:after_greeting_silence_millis 0
:between_words_silence_millis 0
:greeting_duration_millis 0
:greeting_silence_duration_millis 0
:greeting_total_analysis_time_millis 0
:initial_silence_millis 0
:maximum_number_of_words 0
:maximum_word_length_millis 0
:silence_threshold 0
:total_analysis_time_millis 0}
:audio_url ""
:client_state ""
:command_id ""
:custom_headers [{:name ""
:value ""}]
:from ""
:from_display_name ""
:media_name ""
:sip_auth_password ""
:sip_auth_username ""
:target_leg_client_state ""
:time_limit_secs 0
:timeout_secs 0
:to ""
:webhook_url ""
:webhook_url_method ""}})
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id/actions/transfer"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id/actions/transfer"),
Content = new StringContent("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id/actions/transfer");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id/actions/transfer"
payload := strings.NewReader("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/calls/:call_control_id/actions/transfer HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 847
{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/calls/:call_control_id/actions/transfer")
.setHeader("content-type", "application/json")
.setBody("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id/actions/transfer"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/transfer")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/calls/:call_control_id/actions/transfer")
.header("content-type", "application/json")
.body("{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
.asString();
const data = JSON.stringify({
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
client_state: '',
command_id: '',
custom_headers: [
{
name: '',
value: ''
}
],
from: '',
from_display_name: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
target_leg_client_state: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/calls/:call_control_id/actions/transfer');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transfer',
headers: {'content-type': 'application/json'},
data: {
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
client_state: '',
command_id: '',
custom_headers: [{name: '', value: ''}],
from: '',
from_display_name: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
target_leg_client_state: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id/actions/transfer';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"answering_machine_detection":"","answering_machine_detection_config":{"after_greeting_silence_millis":0,"between_words_silence_millis":0,"greeting_duration_millis":0,"greeting_silence_duration_millis":0,"greeting_total_analysis_time_millis":0,"initial_silence_millis":0,"maximum_number_of_words":0,"maximum_word_length_millis":0,"silence_threshold":0,"total_analysis_time_millis":0},"audio_url":"","client_state":"","command_id":"","custom_headers":[{"name":"","value":""}],"from":"","from_display_name":"","media_name":"","sip_auth_password":"","sip_auth_username":"","target_leg_client_state":"","time_limit_secs":0,"timeout_secs":0,"to":"","webhook_url":"","webhook_url_method":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id/actions/transfer',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "answering_machine_detection": "",\n "answering_machine_detection_config": {\n "after_greeting_silence_millis": 0,\n "between_words_silence_millis": 0,\n "greeting_duration_millis": 0,\n "greeting_silence_duration_millis": 0,\n "greeting_total_analysis_time_millis": 0,\n "initial_silence_millis": 0,\n "maximum_number_of_words": 0,\n "maximum_word_length_millis": 0,\n "silence_threshold": 0,\n "total_analysis_time_millis": 0\n },\n "audio_url": "",\n "client_state": "",\n "command_id": "",\n "custom_headers": [\n {\n "name": "",\n "value": ""\n }\n ],\n "from": "",\n "from_display_name": "",\n "media_name": "",\n "sip_auth_password": "",\n "sip_auth_username": "",\n "target_leg_client_state": "",\n "time_limit_secs": 0,\n "timeout_secs": 0,\n "to": "",\n "webhook_url": "",\n "webhook_url_method": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id/actions/transfer")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id/actions/transfer',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
client_state: '',
command_id: '',
custom_headers: [{name: '', value: ''}],
from: '',
from_display_name: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
target_leg_client_state: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transfer',
headers: {'content-type': 'application/json'},
body: {
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
client_state: '',
command_id: '',
custom_headers: [{name: '', value: ''}],
from: '',
from_display_name: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
target_leg_client_state: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/calls/:call_control_id/actions/transfer');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
client_state: '',
command_id: '',
custom_headers: [
{
name: '',
value: ''
}
],
from: '',
from_display_name: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
target_leg_client_state: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/calls/:call_control_id/actions/transfer',
headers: {'content-type': 'application/json'},
data: {
answering_machine_detection: '',
answering_machine_detection_config: {
after_greeting_silence_millis: 0,
between_words_silence_millis: 0,
greeting_duration_millis: 0,
greeting_silence_duration_millis: 0,
greeting_total_analysis_time_millis: 0,
initial_silence_millis: 0,
maximum_number_of_words: 0,
maximum_word_length_millis: 0,
silence_threshold: 0,
total_analysis_time_millis: 0
},
audio_url: '',
client_state: '',
command_id: '',
custom_headers: [{name: '', value: ''}],
from: '',
from_display_name: '',
media_name: '',
sip_auth_password: '',
sip_auth_username: '',
target_leg_client_state: '',
time_limit_secs: 0,
timeout_secs: 0,
to: '',
webhook_url: '',
webhook_url_method: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id/actions/transfer';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"answering_machine_detection":"","answering_machine_detection_config":{"after_greeting_silence_millis":0,"between_words_silence_millis":0,"greeting_duration_millis":0,"greeting_silence_duration_millis":0,"greeting_total_analysis_time_millis":0,"initial_silence_millis":0,"maximum_number_of_words":0,"maximum_word_length_millis":0,"silence_threshold":0,"total_analysis_time_millis":0},"audio_url":"","client_state":"","command_id":"","custom_headers":[{"name":"","value":""}],"from":"","from_display_name":"","media_name":"","sip_auth_password":"","sip_auth_username":"","target_leg_client_state":"","time_limit_secs":0,"timeout_secs":0,"to":"","webhook_url":"","webhook_url_method":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"answering_machine_detection": @"",
@"answering_machine_detection_config": @{ @"after_greeting_silence_millis": @0, @"between_words_silence_millis": @0, @"greeting_duration_millis": @0, @"greeting_silence_duration_millis": @0, @"greeting_total_analysis_time_millis": @0, @"initial_silence_millis": @0, @"maximum_number_of_words": @0, @"maximum_word_length_millis": @0, @"silence_threshold": @0, @"total_analysis_time_millis": @0 },
@"audio_url": @"",
@"client_state": @"",
@"command_id": @"",
@"custom_headers": @[ @{ @"name": @"", @"value": @"" } ],
@"from": @"",
@"from_display_name": @"",
@"media_name": @"",
@"sip_auth_password": @"",
@"sip_auth_username": @"",
@"target_leg_client_state": @"",
@"time_limit_secs": @0,
@"timeout_secs": @0,
@"to": @"",
@"webhook_url": @"",
@"webhook_url_method": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id/actions/transfer"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id/actions/transfer" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id/actions/transfer",
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([
'answering_machine_detection' => '',
'answering_machine_detection_config' => [
'after_greeting_silence_millis' => 0,
'between_words_silence_millis' => 0,
'greeting_duration_millis' => 0,
'greeting_silence_duration_millis' => 0,
'greeting_total_analysis_time_millis' => 0,
'initial_silence_millis' => 0,
'maximum_number_of_words' => 0,
'maximum_word_length_millis' => 0,
'silence_threshold' => 0,
'total_analysis_time_millis' => 0
],
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'from' => '',
'from_display_name' => '',
'media_name' => '',
'sip_auth_password' => '',
'sip_auth_username' => '',
'target_leg_client_state' => '',
'time_limit_secs' => 0,
'timeout_secs' => 0,
'to' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]),
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;
}
request('POST', '{{baseUrl}}/calls/:call_control_id/actions/transfer', [
'body' => '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id/actions/transfer');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'answering_machine_detection' => '',
'answering_machine_detection_config' => [
'after_greeting_silence_millis' => 0,
'between_words_silence_millis' => 0,
'greeting_duration_millis' => 0,
'greeting_silence_duration_millis' => 0,
'greeting_total_analysis_time_millis' => 0,
'initial_silence_millis' => 0,
'maximum_number_of_words' => 0,
'maximum_word_length_millis' => 0,
'silence_threshold' => 0,
'total_analysis_time_millis' => 0
],
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'from' => '',
'from_display_name' => '',
'media_name' => '',
'sip_auth_password' => '',
'sip_auth_username' => '',
'target_leg_client_state' => '',
'time_limit_secs' => 0,
'timeout_secs' => 0,
'to' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'answering_machine_detection' => '',
'answering_machine_detection_config' => [
'after_greeting_silence_millis' => 0,
'between_words_silence_millis' => 0,
'greeting_duration_millis' => 0,
'greeting_silence_duration_millis' => 0,
'greeting_total_analysis_time_millis' => 0,
'initial_silence_millis' => 0,
'maximum_number_of_words' => 0,
'maximum_word_length_millis' => 0,
'silence_threshold' => 0,
'total_analysis_time_millis' => 0
],
'audio_url' => '',
'client_state' => '',
'command_id' => '',
'custom_headers' => [
[
'name' => '',
'value' => ''
]
],
'from' => '',
'from_display_name' => '',
'media_name' => '',
'sip_auth_password' => '',
'sip_auth_username' => '',
'target_leg_client_state' => '',
'time_limit_secs' => 0,
'timeout_secs' => 0,
'to' => '',
'webhook_url' => '',
'webhook_url_method' => ''
]));
$request->setRequestUrl('{{baseUrl}}/calls/:call_control_id/actions/transfer');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id/actions/transfer' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id/actions/transfer' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/calls/:call_control_id/actions/transfer", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id/actions/transfer"
payload = {
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id/actions/transfer"
payload <- "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id/actions/transfer")
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 \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/calls/:call_control_id/actions/transfer') do |req|
req.body = "{\n \"answering_machine_detection\": \"\",\n \"answering_machine_detection_config\": {\n \"after_greeting_silence_millis\": 0,\n \"between_words_silence_millis\": 0,\n \"greeting_duration_millis\": 0,\n \"greeting_silence_duration_millis\": 0,\n \"greeting_total_analysis_time_millis\": 0,\n \"initial_silence_millis\": 0,\n \"maximum_number_of_words\": 0,\n \"maximum_word_length_millis\": 0,\n \"silence_threshold\": 0,\n \"total_analysis_time_millis\": 0\n },\n \"audio_url\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"custom_headers\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"from\": \"\",\n \"from_display_name\": \"\",\n \"media_name\": \"\",\n \"sip_auth_password\": \"\",\n \"sip_auth_username\": \"\",\n \"target_leg_client_state\": \"\",\n \"time_limit_secs\": 0,\n \"timeout_secs\": 0,\n \"to\": \"\",\n \"webhook_url\": \"\",\n \"webhook_url_method\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id/actions/transfer";
let payload = json!({
"answering_machine_detection": "",
"answering_machine_detection_config": json!({
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
}),
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": (
json!({
"name": "",
"value": ""
})
),
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/calls/:call_control_id/actions/transfer \
--header 'content-type: application/json' \
--data '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}'
echo '{
"answering_machine_detection": "",
"answering_machine_detection_config": {
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
},
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
{
"name": "",
"value": ""
}
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
}' | \
http POST {{baseUrl}}/calls/:call_control_id/actions/transfer \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "answering_machine_detection": "",\n "answering_machine_detection_config": {\n "after_greeting_silence_millis": 0,\n "between_words_silence_millis": 0,\n "greeting_duration_millis": 0,\n "greeting_silence_duration_millis": 0,\n "greeting_total_analysis_time_millis": 0,\n "initial_silence_millis": 0,\n "maximum_number_of_words": 0,\n "maximum_word_length_millis": 0,\n "silence_threshold": 0,\n "total_analysis_time_millis": 0\n },\n "audio_url": "",\n "client_state": "",\n "command_id": "",\n "custom_headers": [\n {\n "name": "",\n "value": ""\n }\n ],\n "from": "",\n "from_display_name": "",\n "media_name": "",\n "sip_auth_password": "",\n "sip_auth_username": "",\n "target_leg_client_state": "",\n "time_limit_secs": 0,\n "timeout_secs": 0,\n "to": "",\n "webhook_url": "",\n "webhook_url_method": ""\n}' \
--output-document \
- {{baseUrl}}/calls/:call_control_id/actions/transfer
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"answering_machine_detection": "",
"answering_machine_detection_config": [
"after_greeting_silence_millis": 0,
"between_words_silence_millis": 0,
"greeting_duration_millis": 0,
"greeting_silence_duration_millis": 0,
"greeting_total_analysis_time_millis": 0,
"initial_silence_millis": 0,
"maximum_number_of_words": 0,
"maximum_word_length_millis": 0,
"silence_threshold": 0,
"total_analysis_time_millis": 0
],
"audio_url": "",
"client_state": "",
"command_id": "",
"custom_headers": [
[
"name": "",
"value": ""
]
],
"from": "",
"from_display_name": "",
"media_name": "",
"sip_auth_password": "",
"sip_auth_username": "",
"target_leg_client_state": "",
"time_limit_secs": 0,
"timeout_secs": 0,
"to": "",
"webhook_url": "",
"webhook_url_method": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id/actions/transfer")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Create a call control application
{{baseUrl}}/call_control_applications
BODY json
{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/call_control_applications");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/call_control_applications" {:content-type :json
:form-params {:active false
:anchorsite_override ""
:application_name ""
:dtmf_type ""
:first_command_timeout false
:first_command_timeout_secs 0
:inbound {:channel_limit 0
:sip_subdomain ""
:sip_subdomain_receive_settings ""}
:outbound {:channel_limit 0
:outbound_voice_profile_id ""}
:webhook_api_version ""
:webhook_event_failover_url ""
:webhook_event_url ""
:webhook_timeout_secs 0}})
require "http/client"
url = "{{baseUrl}}/call_control_applications"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/call_control_applications"),
Content = new StringContent("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/call_control_applications");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/call_control_applications"
payload := strings.NewReader("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/call_control_applications HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 476
{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/call_control_applications")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/call_control_applications"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/call_control_applications")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/call_control_applications")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.asString();
const data = JSON.stringify({
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/call_control_applications');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/call_control_applications',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/call_control_applications';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","application_name":"","dtmf_type":"","first_command_timeout":false,"first_command_timeout_secs":0,"inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"webhook_api_version":"","webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/call_control_applications',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "anchorsite_override": "",\n "application_name": "",\n "dtmf_type": "",\n "first_command_timeout": false,\n "first_command_timeout_secs": 0,\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "webhook_api_version": "",\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/call_control_applications")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/call_control_applications',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/call_control_applications',
headers: {'content-type': 'application/json'},
body: {
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/call_control_applications');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/call_control_applications',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/call_control_applications';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","application_name":"","dtmf_type":"","first_command_timeout":false,"first_command_timeout_secs":0,"inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"webhook_api_version":"","webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"anchorsite_override": @"",
@"application_name": @"",
@"dtmf_type": @"",
@"first_command_timeout": @NO,
@"first_command_timeout_secs": @0,
@"inbound": @{ @"channel_limit": @0, @"sip_subdomain": @"", @"sip_subdomain_receive_settings": @"" },
@"outbound": @{ @"channel_limit": @0, @"outbound_voice_profile_id": @"" },
@"webhook_api_version": @"",
@"webhook_event_failover_url": @"",
@"webhook_event_url": @"",
@"webhook_timeout_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/call_control_applications"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/call_control_applications" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/call_control_applications",
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([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]),
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;
}
request('POST', '{{baseUrl}}/call_control_applications', [
'body' => '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/call_control_applications');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/call_control_applications');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/call_control_applications' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/call_control_applications' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/call_control_applications", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/call_control_applications"
payload = {
"active": False,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": False,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/call_control_applications"
payload <- "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/call_control_applications")
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 \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/call_control_applications') do |req|
req.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/call_control_applications";
let payload = json!({
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": json!({
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
}),
"outbound": json!({
"channel_limit": 0,
"outbound_voice_profile_id": ""
}),
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/call_control_applications \
--header 'content-type: application/json' \
--data '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
echo '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}' | \
http POST {{baseUrl}}/call_control_applications \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "anchorsite_override": "",\n "application_name": "",\n "dtmf_type": "",\n "first_command_timeout": false,\n "first_command_timeout_secs": 0,\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "webhook_api_version": "",\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}' \
--output-document \
- {{baseUrl}}/call_control_applications
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": [
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
],
"outbound": [
"channel_limit": 0,
"outbound_voice_profile_id": ""
],
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/call_control_applications")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "\"Latency\"",
"application_name": "call-router",
"created_at": "2018-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "call_control_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
DELETE
Delete a call control application
{{baseUrl}}/call_control_applications/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/call_control_applications/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/call_control_applications/:id")
require "http/client"
url = "{{baseUrl}}/call_control_applications/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/call_control_applications/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/call_control_applications/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/call_control_applications/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/call_control_applications/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/call_control_applications/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/call_control_applications/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/call_control_applications/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/call_control_applications/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/call_control_applications/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/call_control_applications/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/call_control_applications/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/call_control_applications/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/call_control_applications/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/call_control_applications/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/call_control_applications/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/call_control_applications/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/call_control_applications/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/call_control_applications/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/call_control_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/call_control_applications/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/call_control_applications/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/call_control_applications/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/call_control_applications/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/call_control_applications/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/call_control_applications/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/call_control_applications/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/call_control_applications/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/call_control_applications/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/call_control_applications/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/call_control_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/call_control_applications/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/call_control_applications/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/call_control_applications/:id
http DELETE {{baseUrl}}/call_control_applications/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/call_control_applications/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/call_control_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "\"Latency\"",
"application_name": "call-router",
"created_at": "2018-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "call_control_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
GET
List call control applications
{{baseUrl}}/call_control_applications
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/call_control_applications");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/call_control_applications")
require "http/client"
url = "{{baseUrl}}/call_control_applications"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/call_control_applications"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/call_control_applications");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/call_control_applications"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/call_control_applications HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/call_control_applications")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/call_control_applications"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/call_control_applications")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/call_control_applications")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/call_control_applications');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/call_control_applications'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/call_control_applications';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/call_control_applications',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/call_control_applications")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/call_control_applications',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/call_control_applications'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/call_control_applications');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/call_control_applications'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/call_control_applications';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/call_control_applications"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/call_control_applications" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/call_control_applications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/call_control_applications');
echo $response->getBody();
setUrl('{{baseUrl}}/call_control_applications');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/call_control_applications');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/call_control_applications' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/call_control_applications' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/call_control_applications")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/call_control_applications"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/call_control_applications"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/call_control_applications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/call_control_applications') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/call_control_applications";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/call_control_applications
http GET {{baseUrl}}/call_control_applications
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/call_control_applications
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/call_control_applications")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": false,
"anchorsite_override": "\"Latency\"",
"application_name": "call-router",
"created_at": "2018-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "call_control_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a call control application
{{baseUrl}}/call_control_applications/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/call_control_applications/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/call_control_applications/:id")
require "http/client"
url = "{{baseUrl}}/call_control_applications/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/call_control_applications/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/call_control_applications/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/call_control_applications/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/call_control_applications/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/call_control_applications/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/call_control_applications/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/call_control_applications/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/call_control_applications/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/call_control_applications/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/call_control_applications/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/call_control_applications/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/call_control_applications/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/call_control_applications/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/call_control_applications/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/call_control_applications/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/call_control_applications/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/call_control_applications/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/call_control_applications/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/call_control_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/call_control_applications/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/call_control_applications/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/call_control_applications/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/call_control_applications/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/call_control_applications/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/call_control_applications/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/call_control_applications/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/call_control_applications/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/call_control_applications/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/call_control_applications/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/call_control_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/call_control_applications/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/call_control_applications/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/call_control_applications/:id
http GET {{baseUrl}}/call_control_applications/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/call_control_applications/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/call_control_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "\"Latency\"",
"application_name": "call-router",
"created_at": "2018-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "call_control_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
PATCH
Update a call control application
{{baseUrl}}/call_control_applications/:id
QUERY PARAMS
id
BODY json
{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/call_control_applications/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/call_control_applications/:id" {:content-type :json
:form-params {:active false
:anchorsite_override ""
:application_name ""
:dtmf_type ""
:first_command_timeout false
:first_command_timeout_secs 0
:inbound {:channel_limit 0
:sip_subdomain ""
:sip_subdomain_receive_settings ""}
:outbound {:channel_limit 0
:outbound_voice_profile_id ""}
:webhook_api_version ""
:webhook_event_failover_url ""
:webhook_event_url ""
:webhook_timeout_secs 0}})
require "http/client"
url = "{{baseUrl}}/call_control_applications/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/call_control_applications/:id"),
Content = new StringContent("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/call_control_applications/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/call_control_applications/:id"
payload := strings.NewReader("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/call_control_applications/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 476
{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/call_control_applications/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/call_control_applications/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/call_control_applications/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/call_control_applications/:id")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.asString();
const data = JSON.stringify({
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/call_control_applications/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/call_control_applications/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/call_control_applications/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","application_name":"","dtmf_type":"","first_command_timeout":false,"first_command_timeout_secs":0,"inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"webhook_api_version":"","webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/call_control_applications/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "anchorsite_override": "",\n "application_name": "",\n "dtmf_type": "",\n "first_command_timeout": false,\n "first_command_timeout_secs": 0,\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "webhook_api_version": "",\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/call_control_applications/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/call_control_applications/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/call_control_applications/:id',
headers: {'content-type': 'application/json'},
body: {
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/call_control_applications/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/call_control_applications/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
application_name: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/call_control_applications/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","application_name":"","dtmf_type":"","first_command_timeout":false,"first_command_timeout_secs":0,"inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"webhook_api_version":"","webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"anchorsite_override": @"",
@"application_name": @"",
@"dtmf_type": @"",
@"first_command_timeout": @NO,
@"first_command_timeout_secs": @0,
@"inbound": @{ @"channel_limit": @0, @"sip_subdomain": @"", @"sip_subdomain_receive_settings": @"" },
@"outbound": @{ @"channel_limit": @0, @"outbound_voice_profile_id": @"" },
@"webhook_api_version": @"",
@"webhook_event_failover_url": @"",
@"webhook_event_url": @"",
@"webhook_timeout_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/call_control_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/call_control_applications/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/call_control_applications/:id",
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([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]),
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;
}
request('PATCH', '{{baseUrl}}/call_control_applications/:id', [
'body' => '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/call_control_applications/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/call_control_applications/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/call_control_applications/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/call_control_applications/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/call_control_applications/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/call_control_applications/:id"
payload = {
"active": False,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": False,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/call_control_applications/:id"
payload <- "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/call_control_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/call_control_applications/:id') do |req|
req.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/call_control_applications/:id";
let payload = json!({
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": json!({
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
}),
"outbound": json!({
"channel_limit": 0,
"outbound_voice_profile_id": ""
}),
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/call_control_applications/:id \
--header 'content-type: application/json' \
--data '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
echo '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}' | \
http PATCH {{baseUrl}}/call_control_applications/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "anchorsite_override": "",\n "application_name": "",\n "dtmf_type": "",\n "first_command_timeout": false,\n "first_command_timeout_secs": 0,\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "webhook_api_version": "",\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}' \
--output-document \
- {{baseUrl}}/call_control_applications/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"anchorsite_override": "",
"application_name": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"inbound": [
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
],
"outbound": [
"channel_limit": 0,
"outbound_voice_profile_id": ""
],
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/call_control_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "\"Latency\"",
"application_name": "call-router",
"created_at": "2018-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "call_control_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
GET
Retrieve a call status
{{baseUrl}}/calls/:call_control_id
QUERY PARAMS
call_control_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/calls/:call_control_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/calls/:call_control_id")
require "http/client"
url = "{{baseUrl}}/calls/:call_control_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/calls/:call_control_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/calls/:call_control_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/calls/:call_control_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/calls/:call_control_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/calls/:call_control_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/calls/:call_control_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/calls/:call_control_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/calls/:call_control_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/calls/:call_control_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/calls/:call_control_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/calls/:call_control_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/calls/:call_control_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/calls/:call_control_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/calls/:call_control_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/calls/:call_control_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/calls/:call_control_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/calls/:call_control_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/calls/:call_control_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/calls/:call_control_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/calls/:call_control_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/calls/:call_control_id');
echo $response->getBody();
setUrl('{{baseUrl}}/calls/:call_control_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/calls/:call_control_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/calls/:call_control_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/calls/:call_control_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/calls/:call_control_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/calls/:call_control_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/calls/:call_control_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/calls/:call_control_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/calls/:call_control_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/calls/:call_control_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/calls/:call_control_id
http GET {{baseUrl}}/calls/:call_control_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/calls/:call_control_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/calls/:call_control_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ",
"call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
"call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
"is_alive": false,
"record_type": "call"
}
}
GET
getUsageReportSync
{{baseUrl}}/reports/cdr_usage_reports/sync
QUERY PARAMS
aggregation_type
product_breakdown
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/cdr_usage_reports/sync" {:query-params {:aggregation_type ""
:product_breakdown ""}})
require "http/client"
url = "{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/cdr_usage_reports/sync',
params: {aggregation_type: '', product_breakdown: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/cdr_usage_reports/sync',
qs: {aggregation_type: '', product_breakdown: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/cdr_usage_reports/sync');
req.query({
aggregation_type: '',
product_breakdown: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/cdr_usage_reports/sync',
params: {aggregation_type: '', product_breakdown: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/cdr_usage_reports/sync');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'aggregation_type' => '',
'product_breakdown' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/cdr_usage_reports/sync');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'aggregation_type' => '',
'product_breakdown' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/cdr_usage_reports/sync"
querystring = {"aggregation_type":"","product_breakdown":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/cdr_usage_reports/sync"
queryString <- list(
aggregation_type = "",
product_breakdown = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/cdr_usage_reports/sync') do |req|
req.params['aggregation_type'] = ''
req.params['product_breakdown'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/cdr_usage_reports/sync";
let querystring = [
("aggregation_type", ""),
("product_breakdown", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown='
http GET '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/cdr_usage_reports/sync?aggregation_type=&product_breakdown=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connections": "[1234567890L, 9876543210L]",
"created_at": "2018-02-02T22:25:27.521Z",
"end_time": "2018-02-02T22:25:27.521Z",
"record_type": "cdr_usage_report",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"start_time": "2018-02-02T22:25:27.521Z",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Conference recording start
{{baseUrl}}/conferences/:id/actions/record_start
QUERY PARAMS
id
BODY json
{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/record_start");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/record_start" {:content-type :json
:form-params {:channels ""
:client_state ""
:command_id ""
:format ""
:max_length 0
:play_beep false}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/record_start"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/record_start"),
Content = new StringContent("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/record_start");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/record_start"
payload := strings.NewReader("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/record_start HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 119
{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/record_start")
.setHeader("content-type", "application/json")
.setBody("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/record_start"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/record_start")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/record_start")
.header("content-type", "application/json")
.body("{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}")
.asString();
const data = JSON.stringify({
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/record_start');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/record_start',
headers: {'content-type': 'application/json'},
data: {
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/record_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"channels":"","client_state":"","command_id":"","format":"","max_length":0,"play_beep":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/record_start',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "channels": "",\n "client_state": "",\n "command_id": "",\n "format": "",\n "max_length": 0,\n "play_beep": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/record_start")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/record_start',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/record_start',
headers: {'content-type': 'application/json'},
body: {
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/record_start');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/record_start',
headers: {'content-type': 'application/json'},
data: {
channels: '',
client_state: '',
command_id: '',
format: '',
max_length: 0,
play_beep: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/record_start';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"channels":"","client_state":"","command_id":"","format":"","max_length":0,"play_beep":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"channels": @"",
@"client_state": @"",
@"command_id": @"",
@"format": @"",
@"max_length": @0,
@"play_beep": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/record_start"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/record_start" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/record_start",
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([
'channels' => '',
'client_state' => '',
'command_id' => '',
'format' => '',
'max_length' => 0,
'play_beep' => null
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/record_start', [
'body' => '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/record_start');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'channels' => '',
'client_state' => '',
'command_id' => '',
'format' => '',
'max_length' => 0,
'play_beep' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'channels' => '',
'client_state' => '',
'command_id' => '',
'format' => '',
'max_length' => 0,
'play_beep' => null
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/record_start');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/record_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/record_start' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/record_start", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/record_start"
payload = {
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/record_start"
payload <- "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/record_start")
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 \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/record_start') do |req|
req.body = "{\n \"channels\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"format\": \"\",\n \"max_length\": 0,\n \"play_beep\": false\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/record_start";
let payload = json!({
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/record_start \
--header 'content-type: application/json' \
--data '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}'
echo '{
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
}' | \
http POST {{baseUrl}}/conferences/:id/actions/record_start \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "channels": "",\n "client_state": "",\n "command_id": "",\n "format": "",\n "max_length": 0,\n "play_beep": false\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/record_start
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"channels": "",
"client_state": "",
"command_id": "",
"format": "",
"max_length": 0,
"play_beep": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/record_start")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Conference recording stop
{{baseUrl}}/conferences/:id/actions/record_stop
QUERY PARAMS
id
BODY json
{
"client_state": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/record_stop");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/record_stop" {:content-type :json
:form-params {:client_state ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/record_stop"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/record_stop"),
Content = new StringContent("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/record_stop");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/record_stop"
payload := strings.NewReader("{\n \"client_state\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/record_stop HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"client_state": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/record_stop")
.setHeader("content-type", "application/json")
.setBody("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/record_stop"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/record_stop")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/record_stop")
.header("content-type", "application/json")
.body("{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
client_state: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/record_stop');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/record_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/record_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/record_stop',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "client_state": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/record_stop")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/record_stop',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({client_state: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/record_stop',
headers: {'content-type': 'application/json'},
body: {client_state: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/record_stop');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
client_state: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/record_stop',
headers: {'content-type': 'application/json'},
data: {client_state: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/record_stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"client_state":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"client_state": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/record_stop"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/record_stop" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/record_stop",
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([
'client_state' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/record_stop', [
'body' => '{
"client_state": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/record_stop');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'client_state' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'client_state' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/record_stop');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/record_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/record_stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"client_state": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/record_stop", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/record_stop"
payload = {
"client_state": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/record_stop"
payload <- "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/record_stop")
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 \"client_state\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/record_stop') do |req|
req.body = "{\n \"client_state\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/record_stop";
let payload = json!({
"client_state": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/record_stop \
--header 'content-type: application/json' \
--data '{
"client_state": "",
"command_id": ""
}'
echo '{
"client_state": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/conferences/:id/actions/record_stop \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "client_state": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/record_stop
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"client_state": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/record_stop")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Create conference
{{baseUrl}}/conferences
BODY json
{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences" {:content-type :json
:form-params {:beep_enabled ""
:call_control_id ""
:client_state ""
:comfort_noise false
:command_id ""
:duration_minutes 0
:hold_audio_url ""
:hold_media_name ""
:name ""
:start_conference_on_create false}})
require "http/client"
url = "{{baseUrl}}/conferences"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences"),
Content = new StringContent("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences"
payload := strings.NewReader("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 244
{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences")
.setHeader("content-type", "application/json")
.setBody("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences")
.header("content-type", "application/json")
.body("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}")
.asString();
const data = JSON.stringify({
beep_enabled: '',
call_control_id: '',
client_state: '',
comfort_noise: false,
command_id: '',
duration_minutes: 0,
hold_audio_url: '',
hold_media_name: '',
name: '',
start_conference_on_create: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences',
headers: {'content-type': 'application/json'},
data: {
beep_enabled: '',
call_control_id: '',
client_state: '',
comfort_noise: false,
command_id: '',
duration_minutes: 0,
hold_audio_url: '',
hold_media_name: '',
name: '',
start_conference_on_create: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"beep_enabled":"","call_control_id":"","client_state":"","comfort_noise":false,"command_id":"","duration_minutes":0,"hold_audio_url":"","hold_media_name":"","name":"","start_conference_on_create":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "beep_enabled": "",\n "call_control_id": "",\n "client_state": "",\n "comfort_noise": false,\n "command_id": "",\n "duration_minutes": 0,\n "hold_audio_url": "",\n "hold_media_name": "",\n "name": "",\n "start_conference_on_create": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
beep_enabled: '',
call_control_id: '',
client_state: '',
comfort_noise: false,
command_id: '',
duration_minutes: 0,
hold_audio_url: '',
hold_media_name: '',
name: '',
start_conference_on_create: false
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences',
headers: {'content-type': 'application/json'},
body: {
beep_enabled: '',
call_control_id: '',
client_state: '',
comfort_noise: false,
command_id: '',
duration_minutes: 0,
hold_audio_url: '',
hold_media_name: '',
name: '',
start_conference_on_create: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
beep_enabled: '',
call_control_id: '',
client_state: '',
comfort_noise: false,
command_id: '',
duration_minutes: 0,
hold_audio_url: '',
hold_media_name: '',
name: '',
start_conference_on_create: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences',
headers: {'content-type': 'application/json'},
data: {
beep_enabled: '',
call_control_id: '',
client_state: '',
comfort_noise: false,
command_id: '',
duration_minutes: 0,
hold_audio_url: '',
hold_media_name: '',
name: '',
start_conference_on_create: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"beep_enabled":"","call_control_id":"","client_state":"","comfort_noise":false,"command_id":"","duration_minutes":0,"hold_audio_url":"","hold_media_name":"","name":"","start_conference_on_create":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"beep_enabled": @"",
@"call_control_id": @"",
@"client_state": @"",
@"comfort_noise": @NO,
@"command_id": @"",
@"duration_minutes": @0,
@"hold_audio_url": @"",
@"hold_media_name": @"",
@"name": @"",
@"start_conference_on_create": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences",
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([
'beep_enabled' => '',
'call_control_id' => '',
'client_state' => '',
'comfort_noise' => null,
'command_id' => '',
'duration_minutes' => 0,
'hold_audio_url' => '',
'hold_media_name' => '',
'name' => '',
'start_conference_on_create' => null
]),
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;
}
request('POST', '{{baseUrl}}/conferences', [
'body' => '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'beep_enabled' => '',
'call_control_id' => '',
'client_state' => '',
'comfort_noise' => null,
'command_id' => '',
'duration_minutes' => 0,
'hold_audio_url' => '',
'hold_media_name' => '',
'name' => '',
'start_conference_on_create' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'beep_enabled' => '',
'call_control_id' => '',
'client_state' => '',
'comfort_noise' => null,
'command_id' => '',
'duration_minutes' => 0,
'hold_audio_url' => '',
'hold_media_name' => '',
'name' => '',
'start_conference_on_create' => null
]));
$request->setRequestUrl('{{baseUrl}}/conferences');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences"
payload = {
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": False,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences"
payload <- "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences")
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 \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences') do |req|
req.body = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"comfort_noise\": false,\n \"command_id\": \"\",\n \"duration_minutes\": 0,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"name\": \"\",\n \"start_conference_on_create\": false\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences";
let payload = json!({
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences \
--header 'content-type: application/json' \
--data '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
}'
echo '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
}' | \
http POST {{baseUrl}}/conferences \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "beep_enabled": "",\n "call_control_id": "",\n "client_state": "",\n "comfort_noise": false,\n "command_id": "",\n "duration_minutes": 0,\n "hold_audio_url": "",\n "hold_media_name": "",\n "name": "",\n "start_conference_on_create": false\n}' \
--output-document \
- {{baseUrl}}/conferences
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"comfort_noise": false,
"command_id": "",
"duration_minutes": 0,
"hold_audio_url": "",
"hold_media_name": "",
"name": "",
"start_conference_on_create": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "3fa85f64-9191-4567-b3fc-2c963f66afa6",
"created_at": "2019-01-23T18:10:02.574Z",
"end_reason": "all_left",
"ended_by": {
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==",
"call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1"
},
"expires_at": "2019-01-23T18:10:02.574Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "All hands meeting",
"record_type": "conference",
"region": "sv1",
"status": "completed",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
POST
Dial a new participant into a conference
{{baseUrl}}/conferences/:id/actions/dial_participant
QUERY PARAMS
id
BODY json
{
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/dial_participant");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/dial_participant" {:content-type :json
:form-params {:call_control_id ""
:client_state ""
:command_id ""
:from ""
:hold false
:hold_audio_url ""
:hold_media_name ""
:mute false
:start_conference_on_enter false
:supervisor_role ""
:to ""
:whisper_call_control_ids []}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/dial_participant"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/dial_participant"),
Content = new StringContent("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/dial_participant");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/dial_participant"
payload := strings.NewReader("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/dial_participant HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 275
{
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/dial_participant")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/dial_participant"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/dial_participant")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/dial_participant")
.header("content-type", "application/json")
.body("{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}")
.asString();
const data = JSON.stringify({
call_control_id: '',
client_state: '',
command_id: '',
from: '',
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
start_conference_on_enter: false,
supervisor_role: '',
to: '',
whisper_call_control_ids: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/dial_participant');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/dial_participant',
headers: {'content-type': 'application/json'},
data: {
call_control_id: '',
client_state: '',
command_id: '',
from: '',
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
start_conference_on_enter: false,
supervisor_role: '',
to: '',
whisper_call_control_ids: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/dial_participant';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_id":"","client_state":"","command_id":"","from":"","hold":false,"hold_audio_url":"","hold_media_name":"","mute":false,"start_conference_on_enter":false,"supervisor_role":"","to":"","whisper_call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/dial_participant',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_control_id": "",\n "client_state": "",\n "command_id": "",\n "from": "",\n "hold": false,\n "hold_audio_url": "",\n "hold_media_name": "",\n "mute": false,\n "start_conference_on_enter": false,\n "supervisor_role": "",\n "to": "",\n "whisper_call_control_ids": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/dial_participant")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/dial_participant',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
call_control_id: '',
client_state: '',
command_id: '',
from: '',
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
start_conference_on_enter: false,
supervisor_role: '',
to: '',
whisper_call_control_ids: []
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/dial_participant',
headers: {'content-type': 'application/json'},
body: {
call_control_id: '',
client_state: '',
command_id: '',
from: '',
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
start_conference_on_enter: false,
supervisor_role: '',
to: '',
whisper_call_control_ids: []
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/dial_participant');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_control_id: '',
client_state: '',
command_id: '',
from: '',
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
start_conference_on_enter: false,
supervisor_role: '',
to: '',
whisper_call_control_ids: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/dial_participant',
headers: {'content-type': 'application/json'},
data: {
call_control_id: '',
client_state: '',
command_id: '',
from: '',
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
start_conference_on_enter: false,
supervisor_role: '',
to: '',
whisper_call_control_ids: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/dial_participant';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_id":"","client_state":"","command_id":"","from":"","hold":false,"hold_audio_url":"","hold_media_name":"","mute":false,"start_conference_on_enter":false,"supervisor_role":"","to":"","whisper_call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_control_id": @"",
@"client_state": @"",
@"command_id": @"",
@"from": @"",
@"hold": @NO,
@"hold_audio_url": @"",
@"hold_media_name": @"",
@"mute": @NO,
@"start_conference_on_enter": @NO,
@"supervisor_role": @"",
@"to": @"",
@"whisper_call_control_ids": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/dial_participant"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/dial_participant" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/dial_participant",
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([
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'from' => '',
'hold' => null,
'hold_audio_url' => '',
'hold_media_name' => '',
'mute' => null,
'start_conference_on_enter' => null,
'supervisor_role' => '',
'to' => '',
'whisper_call_control_ids' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/dial_participant', [
'body' => '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/dial_participant');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'from' => '',
'hold' => null,
'hold_audio_url' => '',
'hold_media_name' => '',
'mute' => null,
'start_conference_on_enter' => null,
'supervisor_role' => '',
'to' => '',
'whisper_call_control_ids' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'from' => '',
'hold' => null,
'hold_audio_url' => '',
'hold_media_name' => '',
'mute' => null,
'start_conference_on_enter' => null,
'supervisor_role' => '',
'to' => '',
'whisper_call_control_ids' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/dial_participant');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/dial_participant' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/dial_participant' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/dial_participant", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/dial_participant"
payload = {
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": False,
"hold_audio_url": "",
"hold_media_name": "",
"mute": False,
"start_conference_on_enter": False,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/dial_participant"
payload <- "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/dial_participant")
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 \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/dial_participant') do |req|
req.body = "{\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"from\": \"\",\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"to\": \"\",\n \"whisper_call_control_ids\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/dial_participant";
let payload = json!({
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/dial_participant \
--header 'content-type: application/json' \
--data '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
}'
echo '{
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
}' | \
http POST {{baseUrl}}/conferences/:id/actions/dial_participant \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_control_id": "",\n "client_state": "",\n "command_id": "",\n "from": "",\n "hold": false,\n "hold_audio_url": "",\n "hold_media_name": "",\n "mute": false,\n "start_conference_on_enter": false,\n "supervisor_role": "",\n "to": "",\n "whisper_call_control_ids": []\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/dial_participant
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"call_control_id": "",
"client_state": "",
"command_id": "",
"from": "",
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"to": "",
"whisper_call_control_ids": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/dial_participant")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Hold conference participants
{{baseUrl}}/conferences/:id/actions/hold
QUERY PARAMS
id
BODY json
{
"audio_url": "",
"call_control_ids": [],
"media_name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/hold");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/hold" {:content-type :json
:form-params {:audio_url ""
:call_control_ids []
:media_name ""}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/hold"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/hold"),
Content = new StringContent("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/hold");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/hold"
payload := strings.NewReader("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/hold HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 67
{
"audio_url": "",
"call_control_ids": [],
"media_name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/hold")
.setHeader("content-type", "application/json")
.setBody("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/hold"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/hold")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/hold")
.header("content-type", "application/json")
.body("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}")
.asString();
const data = JSON.stringify({
audio_url: '',
call_control_ids: [],
media_name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/hold');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/hold',
headers: {'content-type': 'application/json'},
data: {audio_url: '', call_control_ids: [], media_name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/hold';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio_url":"","call_control_ids":[],"media_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/hold',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "audio_url": "",\n "call_control_ids": [],\n "media_name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/hold")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/hold',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({audio_url: '', call_control_ids: [], media_name: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/hold',
headers: {'content-type': 'application/json'},
body: {audio_url: '', call_control_ids: [], media_name: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/hold');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
audio_url: '',
call_control_ids: [],
media_name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/hold',
headers: {'content-type': 'application/json'},
data: {audio_url: '', call_control_ids: [], media_name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/hold';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio_url":"","call_control_ids":[],"media_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"audio_url": @"",
@"call_control_ids": @[ ],
@"media_name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/hold"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/hold" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/hold",
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([
'audio_url' => '',
'call_control_ids' => [
],
'media_name' => ''
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/hold', [
'body' => '{
"audio_url": "",
"call_control_ids": [],
"media_name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/hold');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'audio_url' => '',
'call_control_ids' => [
],
'media_name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'audio_url' => '',
'call_control_ids' => [
],
'media_name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/hold');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/hold' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio_url": "",
"call_control_ids": [],
"media_name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/hold' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio_url": "",
"call_control_ids": [],
"media_name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/hold", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/hold"
payload = {
"audio_url": "",
"call_control_ids": [],
"media_name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/hold"
payload <- "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/hold")
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 \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/hold') do |req|
req.body = "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"media_name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/hold";
let payload = json!({
"audio_url": "",
"call_control_ids": (),
"media_name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/hold \
--header 'content-type: application/json' \
--data '{
"audio_url": "",
"call_control_ids": [],
"media_name": ""
}'
echo '{
"audio_url": "",
"call_control_ids": [],
"media_name": ""
}' | \
http POST {{baseUrl}}/conferences/:id/actions/hold \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "audio_url": "",\n "call_control_ids": [],\n "media_name": ""\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/hold
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"audio_url": "",
"call_control_ids": [],
"media_name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/hold")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Join a conference
{{baseUrl}}/conferences/:id/actions/join
QUERY PARAMS
id
BODY json
{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/join");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/join" {:content-type :json
:form-params {:beep_enabled ""
:call_control_id ""
:client_state ""
:command_id ""
:end_conference_on_exit false
:hold false
:hold_audio_url ""
:hold_media_name ""
:mute false
:soft_end_conference_on_exit false
:start_conference_on_enter false
:supervisor_role ""
:whisper_call_control_ids []}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/join"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/join"),
Content = new StringContent("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/join");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/join"
payload := strings.NewReader("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/join HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 346
{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/join")
.setHeader("content-type", "application/json")
.setBody("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/join"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/join")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/join")
.header("content-type", "application/json")
.body("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}")
.asString();
const data = JSON.stringify({
beep_enabled: '',
call_control_id: '',
client_state: '',
command_id: '',
end_conference_on_exit: false,
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
soft_end_conference_on_exit: false,
start_conference_on_enter: false,
supervisor_role: '',
whisper_call_control_ids: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/join');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/join',
headers: {'content-type': 'application/json'},
data: {
beep_enabled: '',
call_control_id: '',
client_state: '',
command_id: '',
end_conference_on_exit: false,
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
soft_end_conference_on_exit: false,
start_conference_on_enter: false,
supervisor_role: '',
whisper_call_control_ids: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/join';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"beep_enabled":"","call_control_id":"","client_state":"","command_id":"","end_conference_on_exit":false,"hold":false,"hold_audio_url":"","hold_media_name":"","mute":false,"soft_end_conference_on_exit":false,"start_conference_on_enter":false,"supervisor_role":"","whisper_call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/join',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "beep_enabled": "",\n "call_control_id": "",\n "client_state": "",\n "command_id": "",\n "end_conference_on_exit": false,\n "hold": false,\n "hold_audio_url": "",\n "hold_media_name": "",\n "mute": false,\n "soft_end_conference_on_exit": false,\n "start_conference_on_enter": false,\n "supervisor_role": "",\n "whisper_call_control_ids": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/join")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/join',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
beep_enabled: '',
call_control_id: '',
client_state: '',
command_id: '',
end_conference_on_exit: false,
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
soft_end_conference_on_exit: false,
start_conference_on_enter: false,
supervisor_role: '',
whisper_call_control_ids: []
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/join',
headers: {'content-type': 'application/json'},
body: {
beep_enabled: '',
call_control_id: '',
client_state: '',
command_id: '',
end_conference_on_exit: false,
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
soft_end_conference_on_exit: false,
start_conference_on_enter: false,
supervisor_role: '',
whisper_call_control_ids: []
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/join');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
beep_enabled: '',
call_control_id: '',
client_state: '',
command_id: '',
end_conference_on_exit: false,
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
soft_end_conference_on_exit: false,
start_conference_on_enter: false,
supervisor_role: '',
whisper_call_control_ids: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/join',
headers: {'content-type': 'application/json'},
data: {
beep_enabled: '',
call_control_id: '',
client_state: '',
command_id: '',
end_conference_on_exit: false,
hold: false,
hold_audio_url: '',
hold_media_name: '',
mute: false,
soft_end_conference_on_exit: false,
start_conference_on_enter: false,
supervisor_role: '',
whisper_call_control_ids: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/join';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"beep_enabled":"","call_control_id":"","client_state":"","command_id":"","end_conference_on_exit":false,"hold":false,"hold_audio_url":"","hold_media_name":"","mute":false,"soft_end_conference_on_exit":false,"start_conference_on_enter":false,"supervisor_role":"","whisper_call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"beep_enabled": @"",
@"call_control_id": @"",
@"client_state": @"",
@"command_id": @"",
@"end_conference_on_exit": @NO,
@"hold": @NO,
@"hold_audio_url": @"",
@"hold_media_name": @"",
@"mute": @NO,
@"soft_end_conference_on_exit": @NO,
@"start_conference_on_enter": @NO,
@"supervisor_role": @"",
@"whisper_call_control_ids": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/join"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/join" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/join",
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([
'beep_enabled' => '',
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'end_conference_on_exit' => null,
'hold' => null,
'hold_audio_url' => '',
'hold_media_name' => '',
'mute' => null,
'soft_end_conference_on_exit' => null,
'start_conference_on_enter' => null,
'supervisor_role' => '',
'whisper_call_control_ids' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/join', [
'body' => '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/join');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'beep_enabled' => '',
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'end_conference_on_exit' => null,
'hold' => null,
'hold_audio_url' => '',
'hold_media_name' => '',
'mute' => null,
'soft_end_conference_on_exit' => null,
'start_conference_on_enter' => null,
'supervisor_role' => '',
'whisper_call_control_ids' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'beep_enabled' => '',
'call_control_id' => '',
'client_state' => '',
'command_id' => '',
'end_conference_on_exit' => null,
'hold' => null,
'hold_audio_url' => '',
'hold_media_name' => '',
'mute' => null,
'soft_end_conference_on_exit' => null,
'start_conference_on_enter' => null,
'supervisor_role' => '',
'whisper_call_control_ids' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/join');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/join' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/join' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/join", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/join"
payload = {
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": False,
"hold": False,
"hold_audio_url": "",
"hold_media_name": "",
"mute": False,
"soft_end_conference_on_exit": False,
"start_conference_on_enter": False,
"supervisor_role": "",
"whisper_call_control_ids": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/join"
payload <- "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/join")
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 \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/join') do |req|
req.body = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"client_state\": \"\",\n \"command_id\": \"\",\n \"end_conference_on_exit\": false,\n \"hold\": false,\n \"hold_audio_url\": \"\",\n \"hold_media_name\": \"\",\n \"mute\": false,\n \"soft_end_conference_on_exit\": false,\n \"start_conference_on_enter\": false,\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/join";
let payload = json!({
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/join \
--header 'content-type: application/json' \
--data '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": []
}'
echo '{
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": []
}' | \
http POST {{baseUrl}}/conferences/:id/actions/join \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "beep_enabled": "",\n "call_control_id": "",\n "client_state": "",\n "command_id": "",\n "end_conference_on_exit": false,\n "hold": false,\n "hold_audio_url": "",\n "hold_media_name": "",\n "mute": false,\n "soft_end_conference_on_exit": false,\n "start_conference_on_enter": false,\n "supervisor_role": "",\n "whisper_call_control_ids": []\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/join
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"beep_enabled": "",
"call_control_id": "",
"client_state": "",
"command_id": "",
"end_conference_on_exit": false,
"hold": false,
"hold_audio_url": "",
"hold_media_name": "",
"mute": false,
"soft_end_conference_on_exit": false,
"start_conference_on_enter": false,
"supervisor_role": "",
"whisper_call_control_ids": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/join")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Leave a conference
{{baseUrl}}/conferences/:id/actions/leave
QUERY PARAMS
id
BODY json
{
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/leave");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/leave" {:content-type :json
:form-params {:beep_enabled ""
:call_control_id ""
:command_id ""}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/leave"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/leave"),
Content = new StringContent("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/leave");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/leave"
payload := strings.NewReader("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/leave HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 69
{
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/leave")
.setHeader("content-type", "application/json")
.setBody("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/leave"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/leave")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/leave")
.header("content-type", "application/json")
.body("{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
beep_enabled: '',
call_control_id: '',
command_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/leave');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/leave',
headers: {'content-type': 'application/json'},
data: {beep_enabled: '', call_control_id: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/leave';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"beep_enabled":"","call_control_id":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/leave',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "beep_enabled": "",\n "call_control_id": "",\n "command_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/leave")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/leave',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({beep_enabled: '', call_control_id: '', command_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/leave',
headers: {'content-type': 'application/json'},
body: {beep_enabled: '', call_control_id: '', command_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/leave');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
beep_enabled: '',
call_control_id: '',
command_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/leave',
headers: {'content-type': 'application/json'},
data: {beep_enabled: '', call_control_id: '', command_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/leave';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"beep_enabled":"","call_control_id":"","command_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"beep_enabled": @"",
@"call_control_id": @"",
@"command_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/leave"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/leave" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/leave",
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([
'beep_enabled' => '',
'call_control_id' => '',
'command_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/leave', [
'body' => '{
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/leave');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'beep_enabled' => '',
'call_control_id' => '',
'command_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'beep_enabled' => '',
'call_control_id' => '',
'command_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/leave');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/leave' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/leave' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/leave", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/leave"
payload = {
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/leave"
payload <- "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/leave")
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 \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/leave') do |req|
req.body = "{\n \"beep_enabled\": \"\",\n \"call_control_id\": \"\",\n \"command_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/leave";
let payload = json!({
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/leave \
--header 'content-type: application/json' \
--data '{
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
}'
echo '{
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
}' | \
http POST {{baseUrl}}/conferences/:id/actions/leave \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "beep_enabled": "",\n "call_control_id": "",\n "command_id": ""\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/leave
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"beep_enabled": "",
"call_control_id": "",
"command_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/leave")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
GET
List conference participants
{{baseUrl}}/conferences/:conference_id/participants
QUERY PARAMS
conference_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:conference_id/participants");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/conferences/:conference_id/participants")
require "http/client"
url = "{{baseUrl}}/conferences/:conference_id/participants"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/conferences/:conference_id/participants"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:conference_id/participants");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:conference_id/participants"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/conferences/:conference_id/participants HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/conferences/:conference_id/participants")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:conference_id/participants"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:conference_id/participants")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/conferences/:conference_id/participants")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/conferences/:conference_id/participants');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/conferences/:conference_id/participants'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:conference_id/participants';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:conference_id/participants',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:conference_id/participants")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:conference_id/participants',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/conferences/:conference_id/participants'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/conferences/:conference_id/participants');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/conferences/:conference_id/participants'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:conference_id/participants';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:conference_id/participants"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:conference_id/participants" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:conference_id/participants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/conferences/:conference_id/participants');
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:conference_id/participants');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/conferences/:conference_id/participants');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:conference_id/participants' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:conference_id/participants' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/conferences/:conference_id/participants")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:conference_id/participants"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:conference_id/participants"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:conference_id/participants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/conferences/:conference_id/participants') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:conference_id/participants";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/conferences/:conference_id/participants
http GET {{baseUrl}}/conferences/:conference_id/participants
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/conferences/:conference_id/participants
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:conference_id/participants")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"call_control_id": "v2:v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ",
"call_leg_id": "3a15df2d-c801-4729-adf5-b56dd42e2abb",
"conference": {
"id": "41b9acd4-f4da-4ff5-a85c-e07e90b53f46",
"name": "1"
},
"created_at": "2019-01-23T18:10:02.574Z",
"end_conference_on_exit": true,
"id": "dfadada7-af74-47bc-83a4-554275f55f5c",
"muted": false,
"on_hold": true,
"record_type": "participant",
"soft_end_conference_on_exit": true,
"status": "joining",
"updated_at": "2019-01-23T18:10:02.574Z",
"whisper_call_control_ids": [
"v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ",
"v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw"
]
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List conferences
{{baseUrl}}/conferences
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/conferences")
require "http/client"
url = "{{baseUrl}}/conferences"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/conferences"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/conferences HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/conferences")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/conferences")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/conferences');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/conferences'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/conferences")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/conferences'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/conferences');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/conferences'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/conferences');
echo $response->getBody();
setUrl('{{baseUrl}}/conferences');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/conferences');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/conferences")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/conferences') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/conferences
http GET {{baseUrl}}/conferences
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/conferences
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"connection_id": "3fa85f64-9191-4567-b3fc-2c963f66afa6",
"created_at": "2019-01-23T18:10:02.574Z",
"end_reason": "all_left",
"ended_by": {
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==",
"call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1"
},
"expires_at": "2019-01-23T18:10:02.574Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "All hands meeting",
"record_type": "conference",
"region": "sv1",
"status": "completed",
"updated_at": "2019-01-23T18:10:02.574Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Mute conference participants
{{baseUrl}}/conferences/:id/actions/mute
QUERY PARAMS
id
BODY json
{
"call_control_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/mute");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_control_ids\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/mute" {:content-type :json
:form-params {:call_control_ids []}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/mute"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_control_ids\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/mute"),
Content = new StringContent("{\n \"call_control_ids\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/mute");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_control_ids\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/mute"
payload := strings.NewReader("{\n \"call_control_ids\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/mute HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 28
{
"call_control_ids": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/mute")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_control_ids\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/mute"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_control_ids\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_control_ids\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/mute")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/mute")
.header("content-type", "application/json")
.body("{\n \"call_control_ids\": []\n}")
.asString();
const data = JSON.stringify({
call_control_ids: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/mute');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/mute',
headers: {'content-type': 'application/json'},
data: {call_control_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/mute';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/mute',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_control_ids": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_control_ids\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/mute")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/mute',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({call_control_ids: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/mute',
headers: {'content-type': 'application/json'},
body: {call_control_ids: []},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/mute');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_control_ids: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/mute',
headers: {'content-type': 'application/json'},
data: {call_control_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/mute';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_control_ids": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/mute"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/mute" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_control_ids\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/mute",
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([
'call_control_ids' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/mute', [
'body' => '{
"call_control_ids": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/mute');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_control_ids' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_control_ids' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/mute');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/mute' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/mute' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_control_ids\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/mute", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/mute"
payload = { "call_control_ids": [] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/mute"
payload <- "{\n \"call_control_ids\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/mute")
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 \"call_control_ids\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/mute') do |req|
req.body = "{\n \"call_control_ids\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/mute";
let payload = json!({"call_control_ids": ()});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/mute \
--header 'content-type: application/json' \
--data '{
"call_control_ids": []
}'
echo '{
"call_control_ids": []
}' | \
http POST {{baseUrl}}/conferences/:id/actions/mute \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_control_ids": []\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/mute
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["call_control_ids": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/mute")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Play audio to conference participants
{{baseUrl}}/conferences/:id/actions/play
QUERY PARAMS
id
BODY json
{
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/play");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/play" {:content-type :json
:form-params {:audio_url ""
:call_control_ids []
:loop ""
:media_name ""}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/play"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/play"),
Content = new StringContent("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/play");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/play"
payload := strings.NewReader("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/play HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 81
{
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/play")
.setHeader("content-type", "application/json")
.setBody("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/play"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/play")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/play")
.header("content-type", "application/json")
.body("{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}")
.asString();
const data = JSON.stringify({
audio_url: '',
call_control_ids: [],
loop: '',
media_name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/play');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/play',
headers: {'content-type': 'application/json'},
data: {audio_url: '', call_control_ids: [], loop: '', media_name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/play';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio_url":"","call_control_ids":[],"loop":"","media_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/play',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "audio_url": "",\n "call_control_ids": [],\n "loop": "",\n "media_name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/play")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/play',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({audio_url: '', call_control_ids: [], loop: '', media_name: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/play',
headers: {'content-type': 'application/json'},
body: {audio_url: '', call_control_ids: [], loop: '', media_name: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/play');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
audio_url: '',
call_control_ids: [],
loop: '',
media_name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/play',
headers: {'content-type': 'application/json'},
data: {audio_url: '', call_control_ids: [], loop: '', media_name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/play';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio_url":"","call_control_ids":[],"loop":"","media_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"audio_url": @"",
@"call_control_ids": @[ ],
@"loop": @"",
@"media_name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/play"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/play" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/play",
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([
'audio_url' => '',
'call_control_ids' => [
],
'loop' => '',
'media_name' => ''
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/play', [
'body' => '{
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/play');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'audio_url' => '',
'call_control_ids' => [
],
'loop' => '',
'media_name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'audio_url' => '',
'call_control_ids' => [
],
'loop' => '',
'media_name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/play');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/play' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/play' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/play", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/play"
payload = {
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/play"
payload <- "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/play")
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 \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/play') do |req|
req.body = "{\n \"audio_url\": \"\",\n \"call_control_ids\": [],\n \"loop\": \"\",\n \"media_name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/play";
let payload = json!({
"audio_url": "",
"call_control_ids": (),
"loop": "",
"media_name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/play \
--header 'content-type: application/json' \
--data '{
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
}'
echo '{
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
}' | \
http POST {{baseUrl}}/conferences/:id/actions/play \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "audio_url": "",\n "call_control_ids": [],\n "loop": "",\n "media_name": ""\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/play
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"audio_url": "",
"call_control_ids": [],
"loop": "",
"media_name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/play")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
GET
Retrieve a conference
{{baseUrl}}/conferences/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/conferences/:id")
require "http/client"
url = "{{baseUrl}}/conferences/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/conferences/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/conferences/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/conferences/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/conferences/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/conferences/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/conferences/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/conferences/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/conferences/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/conferences/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/conferences/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/conferences/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/conferences/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/conferences/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/conferences/:id
http GET {{baseUrl}}/conferences/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/conferences/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "3fa85f64-9191-4567-b3fc-2c963f66afa6",
"created_at": "2019-01-23T18:10:02.574Z",
"end_reason": "all_left",
"ended_by": {
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==",
"call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1"
},
"expires_at": "2019-01-23T18:10:02.574Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "All hands meeting",
"record_type": "conference",
"region": "sv1",
"status": "completed",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
POST
Speak text to conference participants
{{baseUrl}}/conferences/:id/actions/speak
QUERY PARAMS
id
BODY json
{
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/speak");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/speak" {:content-type :json
:form-params {:call_control_ids []
:command_id ""
:language ""
:payload ""
:payload_type ""
:voice ""}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/speak"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/speak"),
Content = new StringContent("{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/speak");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/speak"
payload := strings.NewReader("{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/speak HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 120
{
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/speak")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/speak"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/speak")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/speak")
.header("content-type", "application/json")
.body("{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}")
.asString();
const data = JSON.stringify({
call_control_ids: [],
command_id: '',
language: '',
payload: '',
payload_type: '',
voice: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/speak');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/speak',
headers: {'content-type': 'application/json'},
data: {
call_control_ids: [],
command_id: '',
language: '',
payload: '',
payload_type: '',
voice: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/speak';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[],"command_id":"","language":"","payload":"","payload_type":"","voice":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/speak',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_control_ids": [],\n "command_id": "",\n "language": "",\n "payload": "",\n "payload_type": "",\n "voice": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/speak")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/speak',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
call_control_ids: [],
command_id: '',
language: '',
payload: '',
payload_type: '',
voice: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/speak',
headers: {'content-type': 'application/json'},
body: {
call_control_ids: [],
command_id: '',
language: '',
payload: '',
payload_type: '',
voice: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/speak');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_control_ids: [],
command_id: '',
language: '',
payload: '',
payload_type: '',
voice: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/speak',
headers: {'content-type': 'application/json'},
data: {
call_control_ids: [],
command_id: '',
language: '',
payload: '',
payload_type: '',
voice: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/speak';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[],"command_id":"","language":"","payload":"","payload_type":"","voice":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_control_ids": @[ ],
@"command_id": @"",
@"language": @"",
@"payload": @"",
@"payload_type": @"",
@"voice": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/speak"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/speak" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/speak",
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([
'call_control_ids' => [
],
'command_id' => '',
'language' => '',
'payload' => '',
'payload_type' => '',
'voice' => ''
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/speak', [
'body' => '{
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/speak');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_control_ids' => [
],
'command_id' => '',
'language' => '',
'payload' => '',
'payload_type' => '',
'voice' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_control_ids' => [
],
'command_id' => '',
'language' => '',
'payload' => '',
'payload_type' => '',
'voice' => ''
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/speak');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/speak' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/speak' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/speak", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/speak"
payload = {
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/speak"
payload <- "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/speak")
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 \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/speak') do |req|
req.body = "{\n \"call_control_ids\": [],\n \"command_id\": \"\",\n \"language\": \"\",\n \"payload\": \"\",\n \"payload_type\": \"\",\n \"voice\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/speak";
let payload = json!({
"call_control_ids": (),
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/speak \
--header 'content-type: application/json' \
--data '{
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
}'
echo '{
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
}' | \
http POST {{baseUrl}}/conferences/:id/actions/speak \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_control_ids": [],\n "command_id": "",\n "language": "",\n "payload": "",\n "payload_type": "",\n "voice": ""\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/speak
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"call_control_ids": [],
"command_id": "",
"language": "",
"payload": "",
"payload_type": "",
"voice": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/speak")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Stop audio being played on the conference
{{baseUrl}}/conferences/:id/actions/stop
QUERY PARAMS
id
BODY json
{
"call_control_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/stop");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_control_ids\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/stop" {:content-type :json
:form-params {:call_control_ids []}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/stop"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_control_ids\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/stop"),
Content = new StringContent("{\n \"call_control_ids\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/stop");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_control_ids\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/stop"
payload := strings.NewReader("{\n \"call_control_ids\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/stop HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 28
{
"call_control_ids": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/stop")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_control_ids\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/stop"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_control_ids\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_control_ids\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/stop")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/stop")
.header("content-type", "application/json")
.body("{\n \"call_control_ids\": []\n}")
.asString();
const data = JSON.stringify({
call_control_ids: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/stop');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/stop',
headers: {'content-type': 'application/json'},
data: {call_control_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/stop',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_control_ids": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_control_ids\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/stop")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/stop',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({call_control_ids: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/stop',
headers: {'content-type': 'application/json'},
body: {call_control_ids: []},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/stop');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_control_ids: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/stop',
headers: {'content-type': 'application/json'},
data: {call_control_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/stop';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_control_ids": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/stop"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/stop" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_control_ids\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/stop",
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([
'call_control_ids' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/stop', [
'body' => '{
"call_control_ids": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/stop');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_control_ids' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_control_ids' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/stop');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/stop' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_control_ids\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/stop", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/stop"
payload = { "call_control_ids": [] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/stop"
payload <- "{\n \"call_control_ids\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/stop")
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 \"call_control_ids\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/stop') do |req|
req.body = "{\n \"call_control_ids\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/stop";
let payload = json!({"call_control_ids": ()});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/stop \
--header 'content-type: application/json' \
--data '{
"call_control_ids": []
}'
echo '{
"call_control_ids": []
}' | \
http POST {{baseUrl}}/conferences/:id/actions/stop \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_control_ids": []\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/stop
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["call_control_ids": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/stop")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Unhold conference participants
{{baseUrl}}/conferences/:id/actions/unhold
QUERY PARAMS
id
BODY json
{
"call_control_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/unhold");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_control_ids\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/unhold" {:content-type :json
:form-params {:call_control_ids []}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/unhold"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_control_ids\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/unhold"),
Content = new StringContent("{\n \"call_control_ids\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/unhold");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_control_ids\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/unhold"
payload := strings.NewReader("{\n \"call_control_ids\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/unhold HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 28
{
"call_control_ids": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/unhold")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_control_ids\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/unhold"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_control_ids\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_control_ids\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/unhold")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/unhold")
.header("content-type", "application/json")
.body("{\n \"call_control_ids\": []\n}")
.asString();
const data = JSON.stringify({
call_control_ids: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/unhold');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/unhold',
headers: {'content-type': 'application/json'},
data: {call_control_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/unhold';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/unhold',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_control_ids": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_control_ids\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/unhold")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/unhold',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({call_control_ids: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/unhold',
headers: {'content-type': 'application/json'},
body: {call_control_ids: []},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/unhold');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_control_ids: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/unhold',
headers: {'content-type': 'application/json'},
data: {call_control_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/unhold';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_control_ids": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/unhold"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/unhold" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_control_ids\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/unhold",
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([
'call_control_ids' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/unhold', [
'body' => '{
"call_control_ids": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/unhold');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_control_ids' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_control_ids' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/unhold');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/unhold' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/unhold' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_control_ids\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/unhold", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/unhold"
payload = { "call_control_ids": [] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/unhold"
payload <- "{\n \"call_control_ids\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/unhold")
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 \"call_control_ids\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/unhold') do |req|
req.body = "{\n \"call_control_ids\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/unhold";
let payload = json!({"call_control_ids": ()});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/unhold \
--header 'content-type: application/json' \
--data '{
"call_control_ids": []
}'
echo '{
"call_control_ids": []
}' | \
http POST {{baseUrl}}/conferences/:id/actions/unhold \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_control_ids": []\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/unhold
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["call_control_ids": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/unhold")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Unmute conference participants
{{baseUrl}}/conferences/:id/actions/unmute
QUERY PARAMS
id
BODY json
{
"call_control_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/unmute");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_control_ids\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/unmute" {:content-type :json
:form-params {:call_control_ids []}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/unmute"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_control_ids\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/unmute"),
Content = new StringContent("{\n \"call_control_ids\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/unmute");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_control_ids\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/unmute"
payload := strings.NewReader("{\n \"call_control_ids\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/unmute HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 28
{
"call_control_ids": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/unmute")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_control_ids\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/unmute"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_control_ids\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_control_ids\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/unmute")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/unmute")
.header("content-type", "application/json")
.body("{\n \"call_control_ids\": []\n}")
.asString();
const data = JSON.stringify({
call_control_ids: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/unmute');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/unmute',
headers: {'content-type': 'application/json'},
data: {call_control_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/unmute';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/unmute',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_control_ids": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_control_ids\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/unmute")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/unmute',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({call_control_ids: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/unmute',
headers: {'content-type': 'application/json'},
body: {call_control_ids: []},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/unmute');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_control_ids: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/unmute',
headers: {'content-type': 'application/json'},
data: {call_control_ids: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/unmute';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_control_ids": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/unmute"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/unmute" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_control_ids\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/unmute",
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([
'call_control_ids' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/unmute', [
'body' => '{
"call_control_ids": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/unmute');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_control_ids' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_control_ids' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/unmute');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/unmute' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/unmute' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_ids": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_control_ids\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/unmute", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/unmute"
payload = { "call_control_ids": [] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/unmute"
payload <- "{\n \"call_control_ids\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/unmute")
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 \"call_control_ids\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/unmute') do |req|
req.body = "{\n \"call_control_ids\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/unmute";
let payload = json!({"call_control_ids": ()});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/unmute \
--header 'content-type: application/json' \
--data '{
"call_control_ids": []
}'
echo '{
"call_control_ids": []
}' | \
http POST {{baseUrl}}/conferences/:id/actions/unmute \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_control_ids": []\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/unmute
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["call_control_ids": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/unmute")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Update conference participant
{{baseUrl}}/conferences/:id/actions/update
QUERY PARAMS
id
BODY json
{
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/conferences/:id/actions/update");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/conferences/:id/actions/update" {:content-type :json
:form-params {:call_control_id ""
:command_id ""
:supervisor_role ""
:whisper_call_control_ids []}})
require "http/client"
url = "{{baseUrl}}/conferences/:id/actions/update"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/conferences/:id/actions/update"),
Content = new StringContent("{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/conferences/:id/actions/update");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/conferences/:id/actions/update"
payload := strings.NewReader("{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/conferences/:id/actions/update HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 106
{
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/conferences/:id/actions/update")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/conferences/:id/actions/update"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/update")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/conferences/:id/actions/update")
.header("content-type", "application/json")
.body("{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}")
.asString();
const data = JSON.stringify({
call_control_id: '',
command_id: '',
supervisor_role: '',
whisper_call_control_ids: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/conferences/:id/actions/update');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/update',
headers: {'content-type': 'application/json'},
data: {
call_control_id: '',
command_id: '',
supervisor_role: '',
whisper_call_control_ids: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/conferences/:id/actions/update';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_id":"","command_id":"","supervisor_role":"","whisper_call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/conferences/:id/actions/update',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_control_id": "",\n "command_id": "",\n "supervisor_role": "",\n "whisper_call_control_ids": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/conferences/:id/actions/update")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/conferences/:id/actions/update',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
call_control_id: '',
command_id: '',
supervisor_role: '',
whisper_call_control_ids: []
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/update',
headers: {'content-type': 'application/json'},
body: {
call_control_id: '',
command_id: '',
supervisor_role: '',
whisper_call_control_ids: []
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/conferences/:id/actions/update');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_control_id: '',
command_id: '',
supervisor_role: '',
whisper_call_control_ids: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/conferences/:id/actions/update',
headers: {'content-type': 'application/json'},
data: {
call_control_id: '',
command_id: '',
supervisor_role: '',
whisper_call_control_ids: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/conferences/:id/actions/update';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_control_id":"","command_id":"","supervisor_role":"","whisper_call_control_ids":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_control_id": @"",
@"command_id": @"",
@"supervisor_role": @"",
@"whisper_call_control_ids": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/conferences/:id/actions/update"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/conferences/:id/actions/update" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/conferences/:id/actions/update",
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([
'call_control_id' => '',
'command_id' => '',
'supervisor_role' => '',
'whisper_call_control_ids' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/conferences/:id/actions/update', [
'body' => '{
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/conferences/:id/actions/update');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_control_id' => '',
'command_id' => '',
'supervisor_role' => '',
'whisper_call_control_ids' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_control_id' => '',
'command_id' => '',
'supervisor_role' => '',
'whisper_call_control_ids' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/conferences/:id/actions/update');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/conferences/:id/actions/update' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/conferences/:id/actions/update' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/conferences/:id/actions/update", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/conferences/:id/actions/update"
payload = {
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/conferences/:id/actions/update"
payload <- "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/conferences/:id/actions/update")
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 \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/conferences/:id/actions/update') do |req|
req.body = "{\n \"call_control_id\": \"\",\n \"command_id\": \"\",\n \"supervisor_role\": \"\",\n \"whisper_call_control_ids\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/conferences/:id/actions/update";
let payload = json!({
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/conferences/:id/actions/update \
--header 'content-type: application/json' \
--data '{
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
}'
echo '{
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
}' | \
http POST {{baseUrl}}/conferences/:id/actions/update \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_control_id": "",\n "command_id": "",\n "supervisor_role": "",\n "whisper_call_control_ids": []\n}' \
--output-document \
- {{baseUrl}}/conferences/:id/actions/update
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"call_control_id": "",
"command_id": "",
"supervisor_role": "",
"whisper_call_control_ids": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/conferences/:id/actions/update")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
GET
List connections
{{baseUrl}}/connections
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/connections");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/connections")
require "http/client"
url = "{{baseUrl}}/connections"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/connections"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/connections");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/connections"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/connections HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/connections")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/connections"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/connections")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/connections")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/connections');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/connections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/connections',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/connections")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/connections',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/connections'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/connections');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/connections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/connections"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/connections" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/connections');
echo $response->getBody();
setUrl('{{baseUrl}}/connections');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/connections');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/connections' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/connections' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/connections")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/connections"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/connections"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/connections') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/connections";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/connections
http GET {{baseUrl}}/connections
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/connections
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/connections")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"outbound_voice_profile_id": "1293384261075731499",
"record_type": "ip_connection",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a connection
{{baseUrl}}/connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/connections/:id")
require "http/client"
url = "{{baseUrl}}/connections/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/connections/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/connections/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/connections/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/connections/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/connections/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/connections/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/connections/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/connections/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/connections/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/connections/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/connections/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/connections/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/connections/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/connections/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/connections/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/connections/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/connections/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/connections/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/connections/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/connections/:id
http GET {{baseUrl}}/connections/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"outbound_voice_profile_id": "1293384261075731499",
"record_type": "ip_connection",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com"
}
}
POST
Create a credential connection
{{baseUrl}}/credential_connections
BODY json
{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/credential_connections");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/credential_connections" {:content-type :json
:form-params {:active false
:anchorsite_override ""
:connection_name ""
:default_on_hold_comfort_noise_enabled false
:dtmf_type ""
:encode_contact_header_enabled false
:encrypted_media ""
:inbound {:ani_number_format ""
:channel_limit 0
:codecs []
:dnis_number_format ""
:generate_ringback_tone false
:isup_headers_enabled false
:prack_enabled false
:privacy_zone_enabled false
:sip_compact_headers_enabled false
:timeout_1xx_secs 0
:timeout_2xx_secs ""}
:onnet_t38_passthrough_enabled false
:outbound {:ani_override ""
:ani_override_type ""
:call_parking_enabled false
:channel_limit 0
:generate_ringback_tone false
:instant_ringback_enabled false
:localization ""
:outbound_voice_profile_id ""
:t38_reinvite_source ""}
:password ""
:rtcp_settings {:capture_enabled false
:port ""
:report_frequency_secs 0}
:sip_uri_calling_preference ""
:user_name ""
:webhook_api_version ""
:webhook_event_failover_url ""
:webhook_event_url ""
:webhook_timeout_secs 0}})
require "http/client"
url = "{{baseUrl}}/credential_connections"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/credential_connections"),
Content = new StringContent("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/credential_connections");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/credential_connections"
payload := strings.NewReader("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/credential_connections HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 1202
{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/credential_connections")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/credential_connections"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/credential_connections")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/credential_connections")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.asString();
const data = JSON.stringify({
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {
capture_enabled: false,
port: '',
report_frequency_secs: 0
},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/credential_connections');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/credential_connections',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {capture_enabled: false, port: '', report_frequency_secs: 0},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/credential_connections';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","connection_name":"","default_on_hold_comfort_noise_enabled":false,"dtmf_type":"","encode_contact_header_enabled":false,"encrypted_media":"","inbound":{"ani_number_format":"","channel_limit":0,"codecs":[],"dnis_number_format":"","generate_ringback_tone":false,"isup_headers_enabled":false,"prack_enabled":false,"privacy_zone_enabled":false,"sip_compact_headers_enabled":false,"timeout_1xx_secs":0,"timeout_2xx_secs":""},"onnet_t38_passthrough_enabled":false,"outbound":{"ani_override":"","ani_override_type":"","call_parking_enabled":false,"channel_limit":0,"generate_ringback_tone":false,"instant_ringback_enabled":false,"localization":"","outbound_voice_profile_id":"","t38_reinvite_source":""},"password":"","rtcp_settings":{"capture_enabled":false,"port":"","report_frequency_secs":0},"sip_uri_calling_preference":"","user_name":"","webhook_api_version":"","webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/credential_connections',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "anchorsite_override": "",\n "connection_name": "",\n "default_on_hold_comfort_noise_enabled": false,\n "dtmf_type": "",\n "encode_contact_header_enabled": false,\n "encrypted_media": "",\n "inbound": {\n "ani_number_format": "",\n "channel_limit": 0,\n "codecs": [],\n "dnis_number_format": "",\n "generate_ringback_tone": false,\n "isup_headers_enabled": false,\n "prack_enabled": false,\n "privacy_zone_enabled": false,\n "sip_compact_headers_enabled": false,\n "timeout_1xx_secs": 0,\n "timeout_2xx_secs": ""\n },\n "onnet_t38_passthrough_enabled": false,\n "outbound": {\n "ani_override": "",\n "ani_override_type": "",\n "call_parking_enabled": false,\n "channel_limit": 0,\n "generate_ringback_tone": false,\n "instant_ringback_enabled": false,\n "localization": "",\n "outbound_voice_profile_id": "",\n "t38_reinvite_source": ""\n },\n "password": "",\n "rtcp_settings": {\n "capture_enabled": false,\n "port": "",\n "report_frequency_secs": 0\n },\n "sip_uri_calling_preference": "",\n "user_name": "",\n "webhook_api_version": "",\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/credential_connections")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/credential_connections',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {capture_enabled: false, port: '', report_frequency_secs: 0},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/credential_connections',
headers: {'content-type': 'application/json'},
body: {
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {capture_enabled: false, port: '', report_frequency_secs: 0},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/credential_connections');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {
capture_enabled: false,
port: '',
report_frequency_secs: 0
},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/credential_connections',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {capture_enabled: false, port: '', report_frequency_secs: 0},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/credential_connections';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","connection_name":"","default_on_hold_comfort_noise_enabled":false,"dtmf_type":"","encode_contact_header_enabled":false,"encrypted_media":"","inbound":{"ani_number_format":"","channel_limit":0,"codecs":[],"dnis_number_format":"","generate_ringback_tone":false,"isup_headers_enabled":false,"prack_enabled":false,"privacy_zone_enabled":false,"sip_compact_headers_enabled":false,"timeout_1xx_secs":0,"timeout_2xx_secs":""},"onnet_t38_passthrough_enabled":false,"outbound":{"ani_override":"","ani_override_type":"","call_parking_enabled":false,"channel_limit":0,"generate_ringback_tone":false,"instant_ringback_enabled":false,"localization":"","outbound_voice_profile_id":"","t38_reinvite_source":""},"password":"","rtcp_settings":{"capture_enabled":false,"port":"","report_frequency_secs":0},"sip_uri_calling_preference":"","user_name":"","webhook_api_version":"","webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"anchorsite_override": @"",
@"connection_name": @"",
@"default_on_hold_comfort_noise_enabled": @NO,
@"dtmf_type": @"",
@"encode_contact_header_enabled": @NO,
@"encrypted_media": @"",
@"inbound": @{ @"ani_number_format": @"", @"channel_limit": @0, @"codecs": @[ ], @"dnis_number_format": @"", @"generate_ringback_tone": @NO, @"isup_headers_enabled": @NO, @"prack_enabled": @NO, @"privacy_zone_enabled": @NO, @"sip_compact_headers_enabled": @NO, @"timeout_1xx_secs": @0, @"timeout_2xx_secs": @"" },
@"onnet_t38_passthrough_enabled": @NO,
@"outbound": @{ @"ani_override": @"", @"ani_override_type": @"", @"call_parking_enabled": @NO, @"channel_limit": @0, @"generate_ringback_tone": @NO, @"instant_ringback_enabled": @NO, @"localization": @"", @"outbound_voice_profile_id": @"", @"t38_reinvite_source": @"" },
@"password": @"",
@"rtcp_settings": @{ @"capture_enabled": @NO, @"port": @"", @"report_frequency_secs": @0 },
@"sip_uri_calling_preference": @"",
@"user_name": @"",
@"webhook_api_version": @"",
@"webhook_event_failover_url": @"",
@"webhook_event_url": @"",
@"webhook_timeout_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/credential_connections"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/credential_connections" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/credential_connections",
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([
'active' => null,
'anchorsite_override' => '',
'connection_name' => '',
'default_on_hold_comfort_noise_enabled' => null,
'dtmf_type' => '',
'encode_contact_header_enabled' => null,
'encrypted_media' => '',
'inbound' => [
'ani_number_format' => '',
'channel_limit' => 0,
'codecs' => [
],
'dnis_number_format' => '',
'generate_ringback_tone' => null,
'isup_headers_enabled' => null,
'prack_enabled' => null,
'privacy_zone_enabled' => null,
'sip_compact_headers_enabled' => null,
'timeout_1xx_secs' => 0,
'timeout_2xx_secs' => ''
],
'onnet_t38_passthrough_enabled' => null,
'outbound' => [
'ani_override' => '',
'ani_override_type' => '',
'call_parking_enabled' => null,
'channel_limit' => 0,
'generate_ringback_tone' => null,
'instant_ringback_enabled' => null,
'localization' => '',
'outbound_voice_profile_id' => '',
't38_reinvite_source' => ''
],
'password' => '',
'rtcp_settings' => [
'capture_enabled' => null,
'port' => '',
'report_frequency_secs' => 0
],
'sip_uri_calling_preference' => '',
'user_name' => '',
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]),
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;
}
request('POST', '{{baseUrl}}/credential_connections', [
'body' => '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/credential_connections');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'anchorsite_override' => '',
'connection_name' => '',
'default_on_hold_comfort_noise_enabled' => null,
'dtmf_type' => '',
'encode_contact_header_enabled' => null,
'encrypted_media' => '',
'inbound' => [
'ani_number_format' => '',
'channel_limit' => 0,
'codecs' => [
],
'dnis_number_format' => '',
'generate_ringback_tone' => null,
'isup_headers_enabled' => null,
'prack_enabled' => null,
'privacy_zone_enabled' => null,
'sip_compact_headers_enabled' => null,
'timeout_1xx_secs' => 0,
'timeout_2xx_secs' => ''
],
'onnet_t38_passthrough_enabled' => null,
'outbound' => [
'ani_override' => '',
'ani_override_type' => '',
'call_parking_enabled' => null,
'channel_limit' => 0,
'generate_ringback_tone' => null,
'instant_ringback_enabled' => null,
'localization' => '',
'outbound_voice_profile_id' => '',
't38_reinvite_source' => ''
],
'password' => '',
'rtcp_settings' => [
'capture_enabled' => null,
'port' => '',
'report_frequency_secs' => 0
],
'sip_uri_calling_preference' => '',
'user_name' => '',
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'anchorsite_override' => '',
'connection_name' => '',
'default_on_hold_comfort_noise_enabled' => null,
'dtmf_type' => '',
'encode_contact_header_enabled' => null,
'encrypted_media' => '',
'inbound' => [
'ani_number_format' => '',
'channel_limit' => 0,
'codecs' => [
],
'dnis_number_format' => '',
'generate_ringback_tone' => null,
'isup_headers_enabled' => null,
'prack_enabled' => null,
'privacy_zone_enabled' => null,
'sip_compact_headers_enabled' => null,
'timeout_1xx_secs' => 0,
'timeout_2xx_secs' => ''
],
'onnet_t38_passthrough_enabled' => null,
'outbound' => [
'ani_override' => '',
'ani_override_type' => '',
'call_parking_enabled' => null,
'channel_limit' => 0,
'generate_ringback_tone' => null,
'instant_ringback_enabled' => null,
'localization' => '',
'outbound_voice_profile_id' => '',
't38_reinvite_source' => ''
],
'password' => '',
'rtcp_settings' => [
'capture_enabled' => null,
'port' => '',
'report_frequency_secs' => 0
],
'sip_uri_calling_preference' => '',
'user_name' => '',
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/credential_connections');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/credential_connections' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/credential_connections' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/credential_connections", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/credential_connections"
payload = {
"active": False,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": False,
"dtmf_type": "",
"encode_contact_header_enabled": False,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": False,
"isup_headers_enabled": False,
"prack_enabled": False,
"privacy_zone_enabled": False,
"sip_compact_headers_enabled": False,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": False,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": False,
"channel_limit": 0,
"generate_ringback_tone": False,
"instant_ringback_enabled": False,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": False,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/credential_connections"
payload <- "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/credential_connections")
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 \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/credential_connections') do |req|
req.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/credential_connections";
let payload = json!({
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": json!({
"ani_number_format": "",
"channel_limit": 0,
"codecs": (),
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
}),
"onnet_t38_passthrough_enabled": false,
"outbound": json!({
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
}),
"password": "",
"rtcp_settings": json!({
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
}),
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/credential_connections \
--header 'content-type: application/json' \
--data '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
echo '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}' | \
http POST {{baseUrl}}/credential_connections \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "anchorsite_override": "",\n "connection_name": "",\n "default_on_hold_comfort_noise_enabled": false,\n "dtmf_type": "",\n "encode_contact_header_enabled": false,\n "encrypted_media": "",\n "inbound": {\n "ani_number_format": "",\n "channel_limit": 0,\n "codecs": [],\n "dnis_number_format": "",\n "generate_ringback_tone": false,\n "isup_headers_enabled": false,\n "prack_enabled": false,\n "privacy_zone_enabled": false,\n "sip_compact_headers_enabled": false,\n "timeout_1xx_secs": 0,\n "timeout_2xx_secs": ""\n },\n "onnet_t38_passthrough_enabled": false,\n "outbound": {\n "ani_override": "",\n "ani_override_type": "",\n "call_parking_enabled": false,\n "channel_limit": 0,\n "generate_ringback_tone": false,\n "instant_ringback_enabled": false,\n "localization": "",\n "outbound_voice_profile_id": "",\n "t38_reinvite_source": ""\n },\n "password": "",\n "rtcp_settings": {\n "capture_enabled": false,\n "port": "",\n "report_frequency_secs": 0\n },\n "sip_uri_calling_preference": "",\n "user_name": "",\n "webhook_api_version": "",\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}' \
--output-document \
- {{baseUrl}}/credential_connections
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": [
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
],
"onnet_t38_passthrough_enabled": false,
"outbound": [
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
],
"password": "",
"rtcp_settings": [
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
],
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/credential_connections")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"timeout_1xx_secs": 10,
"timeout_2xx_secs": "15"
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx"
},
"password": "my123secure456password789",
"record_type": "credential_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtp+1",
"report_frequency_seconds": 10
},
"sip_uri_calling_preference": "disabled",
"updated_at": "2018-02-02T22:25:27.521Z",
"user_name": "myusername123",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
DELETE
Delete a credential connection
{{baseUrl}}/credential_connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/credential_connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/credential_connections/:id")
require "http/client"
url = "{{baseUrl}}/credential_connections/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/credential_connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/credential_connections/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/credential_connections/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/credential_connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/credential_connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/credential_connections/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/credential_connections/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/credential_connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/credential_connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/credential_connections/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/credential_connections/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/credential_connections/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/credential_connections/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/credential_connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/credential_connections/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/credential_connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/credential_connections/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/credential_connections/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/credential_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/credential_connections/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/credential_connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/credential_connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/credential_connections/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/credential_connections/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/credential_connections/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/credential_connections/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/credential_connections/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/credential_connections/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/credential_connections/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/credential_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/credential_connections/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/credential_connections/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/credential_connections/:id
http DELETE {{baseUrl}}/credential_connections/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/credential_connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/credential_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"timeout_1xx_secs": 10,
"timeout_2xx_secs": "15"
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx"
},
"password": "my123secure456password789",
"record_type": "credential_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtp+1",
"report_frequency_seconds": 10
},
"sip_uri_calling_preference": "disabled",
"updated_at": "2018-02-02T22:25:27.521Z",
"user_name": "myusername123",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
GET
List credential connections
{{baseUrl}}/credential_connections
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/credential_connections");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/credential_connections")
require "http/client"
url = "{{baseUrl}}/credential_connections"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/credential_connections"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/credential_connections");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/credential_connections"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/credential_connections HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/credential_connections")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/credential_connections"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/credential_connections")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/credential_connections")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/credential_connections');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/credential_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/credential_connections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/credential_connections',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/credential_connections")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/credential_connections',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/credential_connections'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/credential_connections');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/credential_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/credential_connections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/credential_connections"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/credential_connections" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/credential_connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/credential_connections');
echo $response->getBody();
setUrl('{{baseUrl}}/credential_connections');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/credential_connections');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/credential_connections' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/credential_connections' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/credential_connections")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/credential_connections"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/credential_connections"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/credential_connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/credential_connections') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/credential_connections";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/credential_connections
http GET {{baseUrl}}/credential_connections
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/credential_connections
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/credential_connections")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"timeout_1xx_secs": 10,
"timeout_2xx_secs": "15"
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx"
},
"password": "my123secure456password789",
"record_type": "credential_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtp+1",
"report_frequency_seconds": 10
},
"sip_uri_calling_preference": "disabled",
"updated_at": "2018-02-02T22:25:27.521Z",
"user_name": "myusername123",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a credential connection
{{baseUrl}}/credential_connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/credential_connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/credential_connections/:id")
require "http/client"
url = "{{baseUrl}}/credential_connections/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/credential_connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/credential_connections/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/credential_connections/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/credential_connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/credential_connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/credential_connections/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/credential_connections/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/credential_connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/credential_connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/credential_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/credential_connections/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/credential_connections/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/credential_connections/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/credential_connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/credential_connections/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/credential_connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/credential_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/credential_connections/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/credential_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/credential_connections/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/credential_connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/credential_connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/credential_connections/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/credential_connections/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/credential_connections/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/credential_connections/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/credential_connections/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/credential_connections/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/credential_connections/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/credential_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/credential_connections/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/credential_connections/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/credential_connections/:id
http GET {{baseUrl}}/credential_connections/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/credential_connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/credential_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"timeout_1xx_secs": 10,
"timeout_2xx_secs": "15"
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx"
},
"password": "my123secure456password789",
"record_type": "credential_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtp+1",
"report_frequency_seconds": 10
},
"sip_uri_calling_preference": "disabled",
"updated_at": "2018-02-02T22:25:27.521Z",
"user_name": "myusername123",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
PATCH
Update a credential connection
{{baseUrl}}/credential_connections/:id
QUERY PARAMS
id
BODY json
{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/credential_connections/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/credential_connections/:id" {:content-type :json
:form-params {:active false
:anchorsite_override ""
:connection_name ""
:default_on_hold_comfort_noise_enabled false
:dtmf_type ""
:encode_contact_header_enabled false
:encrypted_media ""
:inbound {:ani_number_format ""
:channel_limit 0
:codecs []
:dnis_number_format ""
:generate_ringback_tone false
:isup_headers_enabled false
:prack_enabled false
:privacy_zone_enabled false
:sip_compact_headers_enabled false
:timeout_1xx_secs 0
:timeout_2xx_secs ""}
:onnet_t38_passthrough_enabled false
:outbound {:ani_override ""
:ani_override_type ""
:call_parking_enabled false
:channel_limit 0
:generate_ringback_tone false
:instant_ringback_enabled false
:localization ""
:outbound_voice_profile_id ""
:t38_reinvite_source ""}
:password ""
:rtcp_settings {:capture_enabled false
:port ""
:report_frequency_secs 0}
:sip_uri_calling_preference ""
:user_name ""
:webhook_api_version ""
:webhook_event_failover_url ""
:webhook_event_url ""
:webhook_timeout_secs 0}})
require "http/client"
url = "{{baseUrl}}/credential_connections/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/credential_connections/:id"),
Content = new StringContent("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/credential_connections/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/credential_connections/:id"
payload := strings.NewReader("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/credential_connections/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 1202
{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/credential_connections/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/credential_connections/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/credential_connections/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/credential_connections/:id")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.asString();
const data = JSON.stringify({
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {
capture_enabled: false,
port: '',
report_frequency_secs: 0
},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/credential_connections/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/credential_connections/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {capture_enabled: false, port: '', report_frequency_secs: 0},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/credential_connections/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","connection_name":"","default_on_hold_comfort_noise_enabled":false,"dtmf_type":"","encode_contact_header_enabled":false,"encrypted_media":"","inbound":{"ani_number_format":"","channel_limit":0,"codecs":[],"dnis_number_format":"","generate_ringback_tone":false,"isup_headers_enabled":false,"prack_enabled":false,"privacy_zone_enabled":false,"sip_compact_headers_enabled":false,"timeout_1xx_secs":0,"timeout_2xx_secs":""},"onnet_t38_passthrough_enabled":false,"outbound":{"ani_override":"","ani_override_type":"","call_parking_enabled":false,"channel_limit":0,"generate_ringback_tone":false,"instant_ringback_enabled":false,"localization":"","outbound_voice_profile_id":"","t38_reinvite_source":""},"password":"","rtcp_settings":{"capture_enabled":false,"port":"","report_frequency_secs":0},"sip_uri_calling_preference":"","user_name":"","webhook_api_version":"","webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/credential_connections/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "anchorsite_override": "",\n "connection_name": "",\n "default_on_hold_comfort_noise_enabled": false,\n "dtmf_type": "",\n "encode_contact_header_enabled": false,\n "encrypted_media": "",\n "inbound": {\n "ani_number_format": "",\n "channel_limit": 0,\n "codecs": [],\n "dnis_number_format": "",\n "generate_ringback_tone": false,\n "isup_headers_enabled": false,\n "prack_enabled": false,\n "privacy_zone_enabled": false,\n "sip_compact_headers_enabled": false,\n "timeout_1xx_secs": 0,\n "timeout_2xx_secs": ""\n },\n "onnet_t38_passthrough_enabled": false,\n "outbound": {\n "ani_override": "",\n "ani_override_type": "",\n "call_parking_enabled": false,\n "channel_limit": 0,\n "generate_ringback_tone": false,\n "instant_ringback_enabled": false,\n "localization": "",\n "outbound_voice_profile_id": "",\n "t38_reinvite_source": ""\n },\n "password": "",\n "rtcp_settings": {\n "capture_enabled": false,\n "port": "",\n "report_frequency_secs": 0\n },\n "sip_uri_calling_preference": "",\n "user_name": "",\n "webhook_api_version": "",\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/credential_connections/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/credential_connections/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {capture_enabled: false, port: '', report_frequency_secs: 0},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/credential_connections/:id',
headers: {'content-type': 'application/json'},
body: {
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {capture_enabled: false, port: '', report_frequency_secs: 0},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/credential_connections/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {
capture_enabled: false,
port: '',
report_frequency_secs: 0
},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/credential_connections/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
connection_name: '',
default_on_hold_comfort_noise_enabled: false,
dtmf_type: '',
encode_contact_header_enabled: false,
encrypted_media: '',
inbound: {
ani_number_format: '',
channel_limit: 0,
codecs: [],
dnis_number_format: '',
generate_ringback_tone: false,
isup_headers_enabled: false,
prack_enabled: false,
privacy_zone_enabled: false,
sip_compact_headers_enabled: false,
timeout_1xx_secs: 0,
timeout_2xx_secs: ''
},
onnet_t38_passthrough_enabled: false,
outbound: {
ani_override: '',
ani_override_type: '',
call_parking_enabled: false,
channel_limit: 0,
generate_ringback_tone: false,
instant_ringback_enabled: false,
localization: '',
outbound_voice_profile_id: '',
t38_reinvite_source: ''
},
password: '',
rtcp_settings: {capture_enabled: false, port: '', report_frequency_secs: 0},
sip_uri_calling_preference: '',
user_name: '',
webhook_api_version: '',
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/credential_connections/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","connection_name":"","default_on_hold_comfort_noise_enabled":false,"dtmf_type":"","encode_contact_header_enabled":false,"encrypted_media":"","inbound":{"ani_number_format":"","channel_limit":0,"codecs":[],"dnis_number_format":"","generate_ringback_tone":false,"isup_headers_enabled":false,"prack_enabled":false,"privacy_zone_enabled":false,"sip_compact_headers_enabled":false,"timeout_1xx_secs":0,"timeout_2xx_secs":""},"onnet_t38_passthrough_enabled":false,"outbound":{"ani_override":"","ani_override_type":"","call_parking_enabled":false,"channel_limit":0,"generate_ringback_tone":false,"instant_ringback_enabled":false,"localization":"","outbound_voice_profile_id":"","t38_reinvite_source":""},"password":"","rtcp_settings":{"capture_enabled":false,"port":"","report_frequency_secs":0},"sip_uri_calling_preference":"","user_name":"","webhook_api_version":"","webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"anchorsite_override": @"",
@"connection_name": @"",
@"default_on_hold_comfort_noise_enabled": @NO,
@"dtmf_type": @"",
@"encode_contact_header_enabled": @NO,
@"encrypted_media": @"",
@"inbound": @{ @"ani_number_format": @"", @"channel_limit": @0, @"codecs": @[ ], @"dnis_number_format": @"", @"generate_ringback_tone": @NO, @"isup_headers_enabled": @NO, @"prack_enabled": @NO, @"privacy_zone_enabled": @NO, @"sip_compact_headers_enabled": @NO, @"timeout_1xx_secs": @0, @"timeout_2xx_secs": @"" },
@"onnet_t38_passthrough_enabled": @NO,
@"outbound": @{ @"ani_override": @"", @"ani_override_type": @"", @"call_parking_enabled": @NO, @"channel_limit": @0, @"generate_ringback_tone": @NO, @"instant_ringback_enabled": @NO, @"localization": @"", @"outbound_voice_profile_id": @"", @"t38_reinvite_source": @"" },
@"password": @"",
@"rtcp_settings": @{ @"capture_enabled": @NO, @"port": @"", @"report_frequency_secs": @0 },
@"sip_uri_calling_preference": @"",
@"user_name": @"",
@"webhook_api_version": @"",
@"webhook_event_failover_url": @"",
@"webhook_event_url": @"",
@"webhook_timeout_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/credential_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/credential_connections/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/credential_connections/:id",
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([
'active' => null,
'anchorsite_override' => '',
'connection_name' => '',
'default_on_hold_comfort_noise_enabled' => null,
'dtmf_type' => '',
'encode_contact_header_enabled' => null,
'encrypted_media' => '',
'inbound' => [
'ani_number_format' => '',
'channel_limit' => 0,
'codecs' => [
],
'dnis_number_format' => '',
'generate_ringback_tone' => null,
'isup_headers_enabled' => null,
'prack_enabled' => null,
'privacy_zone_enabled' => null,
'sip_compact_headers_enabled' => null,
'timeout_1xx_secs' => 0,
'timeout_2xx_secs' => ''
],
'onnet_t38_passthrough_enabled' => null,
'outbound' => [
'ani_override' => '',
'ani_override_type' => '',
'call_parking_enabled' => null,
'channel_limit' => 0,
'generate_ringback_tone' => null,
'instant_ringback_enabled' => null,
'localization' => '',
'outbound_voice_profile_id' => '',
't38_reinvite_source' => ''
],
'password' => '',
'rtcp_settings' => [
'capture_enabled' => null,
'port' => '',
'report_frequency_secs' => 0
],
'sip_uri_calling_preference' => '',
'user_name' => '',
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]),
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;
}
request('PATCH', '{{baseUrl}}/credential_connections/:id', [
'body' => '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/credential_connections/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'anchorsite_override' => '',
'connection_name' => '',
'default_on_hold_comfort_noise_enabled' => null,
'dtmf_type' => '',
'encode_contact_header_enabled' => null,
'encrypted_media' => '',
'inbound' => [
'ani_number_format' => '',
'channel_limit' => 0,
'codecs' => [
],
'dnis_number_format' => '',
'generate_ringback_tone' => null,
'isup_headers_enabled' => null,
'prack_enabled' => null,
'privacy_zone_enabled' => null,
'sip_compact_headers_enabled' => null,
'timeout_1xx_secs' => 0,
'timeout_2xx_secs' => ''
],
'onnet_t38_passthrough_enabled' => null,
'outbound' => [
'ani_override' => '',
'ani_override_type' => '',
'call_parking_enabled' => null,
'channel_limit' => 0,
'generate_ringback_tone' => null,
'instant_ringback_enabled' => null,
'localization' => '',
'outbound_voice_profile_id' => '',
't38_reinvite_source' => ''
],
'password' => '',
'rtcp_settings' => [
'capture_enabled' => null,
'port' => '',
'report_frequency_secs' => 0
],
'sip_uri_calling_preference' => '',
'user_name' => '',
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'anchorsite_override' => '',
'connection_name' => '',
'default_on_hold_comfort_noise_enabled' => null,
'dtmf_type' => '',
'encode_contact_header_enabled' => null,
'encrypted_media' => '',
'inbound' => [
'ani_number_format' => '',
'channel_limit' => 0,
'codecs' => [
],
'dnis_number_format' => '',
'generate_ringback_tone' => null,
'isup_headers_enabled' => null,
'prack_enabled' => null,
'privacy_zone_enabled' => null,
'sip_compact_headers_enabled' => null,
'timeout_1xx_secs' => 0,
'timeout_2xx_secs' => ''
],
'onnet_t38_passthrough_enabled' => null,
'outbound' => [
'ani_override' => '',
'ani_override_type' => '',
'call_parking_enabled' => null,
'channel_limit' => 0,
'generate_ringback_tone' => null,
'instant_ringback_enabled' => null,
'localization' => '',
'outbound_voice_profile_id' => '',
't38_reinvite_source' => ''
],
'password' => '',
'rtcp_settings' => [
'capture_enabled' => null,
'port' => '',
'report_frequency_secs' => 0
],
'sip_uri_calling_preference' => '',
'user_name' => '',
'webhook_api_version' => '',
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/credential_connections/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/credential_connections/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/credential_connections/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/credential_connections/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/credential_connections/:id"
payload = {
"active": False,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": False,
"dtmf_type": "",
"encode_contact_header_enabled": False,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": False,
"isup_headers_enabled": False,
"prack_enabled": False,
"privacy_zone_enabled": False,
"sip_compact_headers_enabled": False,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": False,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": False,
"channel_limit": 0,
"generate_ringback_tone": False,
"instant_ringback_enabled": False,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": False,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/credential_connections/:id"
payload <- "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/credential_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/credential_connections/:id') do |req|
req.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"connection_name\": \"\",\n \"default_on_hold_comfort_noise_enabled\": false,\n \"dtmf_type\": \"\",\n \"encode_contact_header_enabled\": false,\n \"encrypted_media\": \"\",\n \"inbound\": {\n \"ani_number_format\": \"\",\n \"channel_limit\": 0,\n \"codecs\": [],\n \"dnis_number_format\": \"\",\n \"generate_ringback_tone\": false,\n \"isup_headers_enabled\": false,\n \"prack_enabled\": false,\n \"privacy_zone_enabled\": false,\n \"sip_compact_headers_enabled\": false,\n \"timeout_1xx_secs\": 0,\n \"timeout_2xx_secs\": \"\"\n },\n \"onnet_t38_passthrough_enabled\": false,\n \"outbound\": {\n \"ani_override\": \"\",\n \"ani_override_type\": \"\",\n \"call_parking_enabled\": false,\n \"channel_limit\": 0,\n \"generate_ringback_tone\": false,\n \"instant_ringback_enabled\": false,\n \"localization\": \"\",\n \"outbound_voice_profile_id\": \"\",\n \"t38_reinvite_source\": \"\"\n },\n \"password\": \"\",\n \"rtcp_settings\": {\n \"capture_enabled\": false,\n \"port\": \"\",\n \"report_frequency_secs\": 0\n },\n \"sip_uri_calling_preference\": \"\",\n \"user_name\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/credential_connections/:id";
let payload = json!({
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": json!({
"ani_number_format": "",
"channel_limit": 0,
"codecs": (),
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
}),
"onnet_t38_passthrough_enabled": false,
"outbound": json!({
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
}),
"password": "",
"rtcp_settings": json!({
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
}),
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/credential_connections/:id \
--header 'content-type: application/json' \
--data '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
echo '{
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": {
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
},
"onnet_t38_passthrough_enabled": false,
"outbound": {
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
},
"password": "",
"rtcp_settings": {
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
},
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}' | \
http PATCH {{baseUrl}}/credential_connections/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "anchorsite_override": "",\n "connection_name": "",\n "default_on_hold_comfort_noise_enabled": false,\n "dtmf_type": "",\n "encode_contact_header_enabled": false,\n "encrypted_media": "",\n "inbound": {\n "ani_number_format": "",\n "channel_limit": 0,\n "codecs": [],\n "dnis_number_format": "",\n "generate_ringback_tone": false,\n "isup_headers_enabled": false,\n "prack_enabled": false,\n "privacy_zone_enabled": false,\n "sip_compact_headers_enabled": false,\n "timeout_1xx_secs": 0,\n "timeout_2xx_secs": ""\n },\n "onnet_t38_passthrough_enabled": false,\n "outbound": {\n "ani_override": "",\n "ani_override_type": "",\n "call_parking_enabled": false,\n "channel_limit": 0,\n "generate_ringback_tone": false,\n "instant_ringback_enabled": false,\n "localization": "",\n "outbound_voice_profile_id": "",\n "t38_reinvite_source": ""\n },\n "password": "",\n "rtcp_settings": {\n "capture_enabled": false,\n "port": "",\n "report_frequency_secs": 0\n },\n "sip_uri_calling_preference": "",\n "user_name": "",\n "webhook_api_version": "",\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}' \
--output-document \
- {{baseUrl}}/credential_connections/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"anchorsite_override": "",
"connection_name": "",
"default_on_hold_comfort_noise_enabled": false,
"dtmf_type": "",
"encode_contact_header_enabled": false,
"encrypted_media": "",
"inbound": [
"ani_number_format": "",
"channel_limit": 0,
"codecs": [],
"dnis_number_format": "",
"generate_ringback_tone": false,
"isup_headers_enabled": false,
"prack_enabled": false,
"privacy_zone_enabled": false,
"sip_compact_headers_enabled": false,
"timeout_1xx_secs": 0,
"timeout_2xx_secs": ""
],
"onnet_t38_passthrough_enabled": false,
"outbound": [
"ani_override": "",
"ani_override_type": "",
"call_parking_enabled": false,
"channel_limit": 0,
"generate_ringback_tone": false,
"instant_ringback_enabled": false,
"localization": "",
"outbound_voice_profile_id": "",
"t38_reinvite_source": ""
],
"password": "",
"rtcp_settings": [
"capture_enabled": false,
"port": "",
"report_frequency_secs": 0
],
"sip_uri_calling_preference": "",
"user_name": "",
"webhook_api_version": "",
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/credential_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"timeout_1xx_secs": 10,
"timeout_2xx_secs": "15"
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx"
},
"password": "my123secure456password789",
"record_type": "credential_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtp+1",
"report_frequency_seconds": 10
},
"sip_uri_calling_preference": "disabled",
"updated_at": "2018-02-02T22:25:27.521Z",
"user_name": "myusername123",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
POST
Create a credential
{{baseUrl}}/telephony_credentials
BODY json
{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/telephony_credentials");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/telephony_credentials" {:content-type :json
:form-params {:connection_id ""
:expires_at ""
:name ""
:tag ""}})
require "http/client"
url = "{{baseUrl}}/telephony_credentials"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/telephony_credentials"),
Content = new StringContent("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/telephony_credentials");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/telephony_credentials"
payload := strings.NewReader("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/telephony_credentials HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 72
{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/telephony_credentials")
.setHeader("content-type", "application/json")
.setBody("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/telephony_credentials"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/telephony_credentials")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/telephony_credentials")
.header("content-type", "application/json")
.body("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
.asString();
const data = JSON.stringify({
connection_id: '',
expires_at: '',
name: '',
tag: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/telephony_credentials');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials',
headers: {'content-type': 'application/json'},
data: {connection_id: '', expires_at: '', name: '', tag: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/telephony_credentials';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","expires_at":"","name":"","tag":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/telephony_credentials',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "connection_id": "",\n "expires_at": "",\n "name": "",\n "tag": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/telephony_credentials")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/telephony_credentials',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({connection_id: '', expires_at: '', name: '', tag: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials',
headers: {'content-type': 'application/json'},
body: {connection_id: '', expires_at: '', name: '', tag: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/telephony_credentials');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
connection_id: '',
expires_at: '',
name: '',
tag: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials',
headers: {'content-type': 'application/json'},
data: {connection_id: '', expires_at: '', name: '', tag: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/telephony_credentials';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","expires_at":"","name":"","tag":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"connection_id": @"",
@"expires_at": @"",
@"name": @"",
@"tag": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/telephony_credentials"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/telephony_credentials" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/telephony_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([
'connection_id' => '',
'expires_at' => '',
'name' => '',
'tag' => ''
]),
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;
}
request('POST', '{{baseUrl}}/telephony_credentials', [
'body' => '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/telephony_credentials');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'connection_id' => '',
'expires_at' => '',
'name' => '',
'tag' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'connection_id' => '',
'expires_at' => '',
'name' => '',
'tag' => ''
]));
$request->setRequestUrl('{{baseUrl}}/telephony_credentials');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/telephony_credentials' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/telephony_credentials' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/telephony_credentials", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/telephony_credentials"
payload = {
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/telephony_credentials"
payload <- "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/telephony_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 \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/telephony_credentials') do |req|
req.body = "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/telephony_credentials";
let payload = json!({
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/telephony_credentials \
--header 'content-type: application/json' \
--data '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}'
echo '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}' | \
http POST {{baseUrl}}/telephony_credentials \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "connection_id": "",\n "expires_at": "",\n "name": "",\n "tag": ""\n}' \
--output-document \
- {{baseUrl}}/telephony_credentials
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/telephony_credentials")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-06-18T21:32:38",
"expired": "false",
"expires_at": "2042-06-18T21:32:38",
"id": "c215ade3-0d39-418e-94be-c5f780760199",
"name": "2020-06-18 21:32:38.917732Z",
"record_type": "credential",
"resource_id": "connection:804252963366242252",
"sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
"sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
"updated_at": "2020-06-18T21:32:38.000Z",
"user_id": "user-id"
}
}
DELETE
Delete a credential
{{baseUrl}}/telephony_credentials/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/telephony_credentials/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/telephony_credentials/:id")
require "http/client"
url = "{{baseUrl}}/telephony_credentials/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/telephony_credentials/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/telephony_credentials/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/telephony_credentials/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/telephony_credentials/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/telephony_credentials/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/telephony_credentials/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/telephony_credentials/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/telephony_credentials/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/telephony_credentials/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/telephony_credentials/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/telephony_credentials/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/telephony_credentials/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/telephony_credentials/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/telephony_credentials/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/telephony_credentials/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/telephony_credentials/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/telephony_credentials/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/telephony_credentials/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/telephony_credentials/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/telephony_credentials/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/telephony_credentials/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/telephony_credentials/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/telephony_credentials/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/telephony_credentials/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/telephony_credentials/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/telephony_credentials/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/telephony_credentials/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/telephony_credentials/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/telephony_credentials/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/telephony_credentials/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/telephony_credentials/:id
http DELETE {{baseUrl}}/telephony_credentials/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/telephony_credentials/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/telephony_credentials/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-06-18T21:32:38",
"expired": "false",
"expires_at": "2042-06-18T21:32:38",
"id": "c215ade3-0d39-418e-94be-c5f780760199",
"name": "2020-06-18 21:32:38.917732Z",
"record_type": "credential",
"resource_id": "connection:804252963366242252",
"sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
"sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
"updated_at": "2020-06-18T21:32:38.000Z",
"user_id": "user-id"
}
}
GET
Get a credential
{{baseUrl}}/telephony_credentials/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/telephony_credentials/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/telephony_credentials/:id")
require "http/client"
url = "{{baseUrl}}/telephony_credentials/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/telephony_credentials/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/telephony_credentials/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/telephony_credentials/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/telephony_credentials/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/telephony_credentials/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/telephony_credentials/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/telephony_credentials/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/telephony_credentials/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/telephony_credentials/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/telephony_credentials/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/telephony_credentials/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/telephony_credentials/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/telephony_credentials/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/telephony_credentials/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/telephony_credentials/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/telephony_credentials/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/telephony_credentials/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/telephony_credentials/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/telephony_credentials/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/telephony_credentials/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/telephony_credentials/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/telephony_credentials/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/telephony_credentials/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/telephony_credentials/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/telephony_credentials/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/telephony_credentials/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/telephony_credentials/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/telephony_credentials/:id
http GET {{baseUrl}}/telephony_credentials/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/telephony_credentials/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/telephony_credentials/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-06-18T21:32:38",
"expired": "false",
"expires_at": "2042-06-18T21:32:38",
"id": "c215ade3-0d39-418e-94be-c5f780760199",
"name": "2020-06-18 21:32:38.917732Z",
"record_type": "credential",
"resource_id": "connection:804252963366242252",
"sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
"sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
"updated_at": "2020-06-18T21:32:38.000Z",
"user_id": "user-id"
}
}
GET
List all credentials
{{baseUrl}}/telephony_credentials
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/telephony_credentials");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/telephony_credentials")
require "http/client"
url = "{{baseUrl}}/telephony_credentials"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/telephony_credentials"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/telephony_credentials");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/telephony_credentials"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/telephony_credentials HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/telephony_credentials")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/telephony_credentials"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/telephony_credentials")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/telephony_credentials")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/telephony_credentials');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/telephony_credentials';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/telephony_credentials',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/telephony_credentials")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/telephony_credentials',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/telephony_credentials');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/telephony_credentials';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/telephony_credentials"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/telephony_credentials" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/telephony_credentials",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/telephony_credentials');
echo $response->getBody();
setUrl('{{baseUrl}}/telephony_credentials');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/telephony_credentials');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/telephony_credentials' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/telephony_credentials' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/telephony_credentials")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/telephony_credentials"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/telephony_credentials"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/telephony_credentials")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/telephony_credentials') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/telephony_credentials";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/telephony_credentials
http GET {{baseUrl}}/telephony_credentials
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/telephony_credentials
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/telephony_credentials")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"created_at": "2020-06-18T21:32:38",
"expired": "false",
"expires_at": "2042-06-18T21:32:38",
"id": "c215ade3-0d39-418e-94be-c5f780760199",
"name": "2020-06-18 21:32:38.917732Z",
"record_type": "credential",
"resource_id": "connection:804252963366242252",
"sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
"sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
"updated_at": "2020-06-18T21:32:38.000Z",
"user_id": "user-id"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List all tags
{{baseUrl}}/telephony_credentials/tags
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/telephony_credentials/tags");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/telephony_credentials/tags")
require "http/client"
url = "{{baseUrl}}/telephony_credentials/tags"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/telephony_credentials/tags"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/telephony_credentials/tags");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/telephony_credentials/tags"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/telephony_credentials/tags HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/telephony_credentials/tags")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/telephony_credentials/tags"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/telephony_credentials/tags")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/telephony_credentials/tags")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/telephony_credentials/tags');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials/tags'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/telephony_credentials/tags';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/telephony_credentials/tags',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/telephony_credentials/tags")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/telephony_credentials/tags',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials/tags'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/telephony_credentials/tags');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/telephony_credentials/tags'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/telephony_credentials/tags';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/telephony_credentials/tags"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/telephony_credentials/tags" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/telephony_credentials/tags",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/telephony_credentials/tags');
echo $response->getBody();
setUrl('{{baseUrl}}/telephony_credentials/tags');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/telephony_credentials/tags');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/telephony_credentials/tags' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/telephony_credentials/tags' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/telephony_credentials/tags")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/telephony_credentials/tags"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/telephony_credentials/tags"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/telephony_credentials/tags")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/telephony_credentials/tags') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/telephony_credentials/tags";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/telephony_credentials/tags
http GET {{baseUrl}}/telephony_credentials/tags
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/telephony_credentials/tags
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/telephony_credentials/tags")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Perform activate or deactivate action on provided Credential
{{baseUrl}}/telephony_credentials/:id/actions/:action
QUERY PARAMS
id
action
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/telephony_credentials/:id/actions/:action");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/telephony_credentials/:id/actions/:action")
require "http/client"
url = "{{baseUrl}}/telephony_credentials/:id/actions/:action"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/telephony_credentials/:id/actions/:action"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/telephony_credentials/:id/actions/:action");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/telephony_credentials/:id/actions/:action"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/telephony_credentials/:id/actions/:action HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/telephony_credentials/:id/actions/:action")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/telephony_credentials/:id/actions/:action"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id/actions/:action")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/telephony_credentials/:id/actions/:action")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/telephony_credentials/:id/actions/:action');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials/:id/actions/:action'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/telephony_credentials/:id/actions/:action';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/telephony_credentials/:id/actions/:action',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id/actions/:action")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/telephony_credentials/:id/actions/:action',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials/:id/actions/:action'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/telephony_credentials/:id/actions/:action');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/telephony_credentials/:id/actions/:action'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/telephony_credentials/:id/actions/:action';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/telephony_credentials/:id/actions/:action"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/telephony_credentials/:id/actions/:action" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/telephony_credentials/:id/actions/:action",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/telephony_credentials/:id/actions/:action');
echo $response->getBody();
setUrl('{{baseUrl}}/telephony_credentials/:id/actions/:action');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/telephony_credentials/:id/actions/:action');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/telephony_credentials/:id/actions/:action' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/telephony_credentials/:id/actions/:action' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/telephony_credentials/:id/actions/:action")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/telephony_credentials/:id/actions/:action"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/telephony_credentials/:id/actions/:action"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/telephony_credentials/:id/actions/:action")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/telephony_credentials/:id/actions/:action') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/telephony_credentials/:id/actions/:action";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/telephony_credentials/:id/actions/:action
http POST {{baseUrl}}/telephony_credentials/:id/actions/:action
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/telephony_credentials/:id/actions/:action
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/telephony_credentials/:id/actions/:action")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-06-18T21:32:38",
"expired": "false",
"expires_at": "2042-06-18T21:32:38",
"id": "c215ade3-0d39-418e-94be-c5f780760199",
"name": "2020-06-18 21:32:38.917732Z",
"record_type": "credential",
"resource_id": "connection:804252963366242252",
"sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
"sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
"updated_at": "2020-06-18T21:32:38.000Z",
"user_id": "user-id"
}
}
PATCH
Update a credential
{{baseUrl}}/telephony_credentials/:id
QUERY PARAMS
id
BODY json
{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/telephony_credentials/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/telephony_credentials/:id" {:content-type :json
:form-params {:connection_id ""
:expires_at ""
:name ""
:tag ""}})
require "http/client"
url = "{{baseUrl}}/telephony_credentials/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/telephony_credentials/:id"),
Content = new StringContent("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/telephony_credentials/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/telephony_credentials/:id"
payload := strings.NewReader("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/telephony_credentials/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 72
{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/telephony_credentials/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/telephony_credentials/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/telephony_credentials/:id")
.header("content-type", "application/json")
.body("{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
.asString();
const data = JSON.stringify({
connection_id: '',
expires_at: '',
name: '',
tag: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/telephony_credentials/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/telephony_credentials/:id',
headers: {'content-type': 'application/json'},
data: {connection_id: '', expires_at: '', name: '', tag: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/telephony_credentials/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","expires_at":"","name":"","tag":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/telephony_credentials/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "connection_id": "",\n "expires_at": "",\n "name": "",\n "tag": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/telephony_credentials/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/telephony_credentials/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({connection_id: '', expires_at: '', name: '', tag: ''}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/telephony_credentials/:id',
headers: {'content-type': 'application/json'},
body: {connection_id: '', expires_at: '', name: '', tag: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/telephony_credentials/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
connection_id: '',
expires_at: '',
name: '',
tag: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/telephony_credentials/:id',
headers: {'content-type': 'application/json'},
data: {connection_id: '', expires_at: '', name: '', tag: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/telephony_credentials/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","expires_at":"","name":"","tag":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"connection_id": @"",
@"expires_at": @"",
@"name": @"",
@"tag": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/telephony_credentials/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/telephony_credentials/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/telephony_credentials/:id",
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([
'connection_id' => '',
'expires_at' => '',
'name' => '',
'tag' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/telephony_credentials/:id', [
'body' => '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/telephony_credentials/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'connection_id' => '',
'expires_at' => '',
'name' => '',
'tag' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'connection_id' => '',
'expires_at' => '',
'name' => '',
'tag' => ''
]));
$request->setRequestUrl('{{baseUrl}}/telephony_credentials/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/telephony_credentials/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/telephony_credentials/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/telephony_credentials/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/telephony_credentials/:id"
payload = {
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/telephony_credentials/:id"
payload <- "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/telephony_credentials/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/telephony_credentials/:id') do |req|
req.body = "{\n \"connection_id\": \"\",\n \"expires_at\": \"\",\n \"name\": \"\",\n \"tag\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/telephony_credentials/:id";
let payload = json!({
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/telephony_credentials/:id \
--header 'content-type: application/json' \
--data '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}'
echo '{
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
}' | \
http PATCH {{baseUrl}}/telephony_credentials/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "connection_id": "",\n "expires_at": "",\n "name": "",\n "tag": ""\n}' \
--output-document \
- {{baseUrl}}/telephony_credentials/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"connection_id": "",
"expires_at": "",
"name": "",
"tag": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/telephony_credentials/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-06-18T21:32:38",
"expired": "false",
"expires_at": "2042-06-18T21:32:38",
"id": "c215ade3-0d39-418e-94be-c5f780760199",
"name": "2020-06-18 21:32:38.917732Z",
"record_type": "credential",
"resource_id": "connection:804252963366242252",
"sip_password": "a92dbcfb60184a8cb330b0acb2f7617b",
"sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX",
"updated_at": "2020-06-18T21:32:38.000Z",
"user_id": "user-id"
}
}
POST
Create a CSV download
{{baseUrl}}/phone_numbers/csv_downloads
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/csv_downloads");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/phone_numbers/csv_downloads")
require "http/client"
url = "{{baseUrl}}/phone_numbers/csv_downloads"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/csv_downloads"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/csv_downloads");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/csv_downloads"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/phone_numbers/csv_downloads HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/phone_numbers/csv_downloads")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/csv_downloads"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/csv_downloads")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/phone_numbers/csv_downloads")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/phone_numbers/csv_downloads');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/phone_numbers/csv_downloads'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/csv_downloads';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/csv_downloads',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/csv_downloads")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/csv_downloads',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/phone_numbers/csv_downloads'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/phone_numbers/csv_downloads');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/phone_numbers/csv_downloads'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/csv_downloads';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/csv_downloads"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/csv_downloads" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/csv_downloads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/phone_numbers/csv_downloads');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/csv_downloads');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/csv_downloads');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/csv_downloads' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/csv_downloads' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/phone_numbers/csv_downloads")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/csv_downloads"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/csv_downloads"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/csv_downloads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/phone_numbers/csv_downloads') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/csv_downloads";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/phone_numbers/csv_downloads
http POST {{baseUrl}}/phone_numbers/csv_downloads
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/phone_numbers/csv_downloads
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/csv_downloads")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "csv_download",
"status": "pending",
"url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7"
}
]
}
GET
List CSV downloads
{{baseUrl}}/phone_numbers/csv_downloads
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/csv_downloads");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/csv_downloads")
require "http/client"
url = "{{baseUrl}}/phone_numbers/csv_downloads"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/csv_downloads"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/csv_downloads");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/csv_downloads"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/csv_downloads HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/csv_downloads")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/csv_downloads"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/csv_downloads")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/csv_downloads")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/csv_downloads');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/csv_downloads'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/csv_downloads';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/csv_downloads',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/csv_downloads")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/csv_downloads',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/csv_downloads'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/csv_downloads');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/csv_downloads'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/csv_downloads';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/csv_downloads"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/csv_downloads" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/csv_downloads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/csv_downloads');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/csv_downloads');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/csv_downloads');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/csv_downloads' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/csv_downloads' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/csv_downloads")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/csv_downloads"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/csv_downloads"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/csv_downloads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/csv_downloads') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/csv_downloads";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/csv_downloads
http GET {{baseUrl}}/phone_numbers/csv_downloads
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/csv_downloads
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/csv_downloads")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "csv_download",
"status": "pending",
"url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a CSV download
{{baseUrl}}/phone_numbers/csv_downloads/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/csv_downloads/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/csv_downloads/:id")
require "http/client"
url = "{{baseUrl}}/phone_numbers/csv_downloads/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/csv_downloads/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/csv_downloads/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/csv_downloads/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/csv_downloads/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/csv_downloads/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/csv_downloads/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/csv_downloads/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/csv_downloads/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/csv_downloads/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/phone_numbers/csv_downloads/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/csv_downloads/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/csv_downloads/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/csv_downloads/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/csv_downloads/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/phone_numbers/csv_downloads/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/csv_downloads/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/phone_numbers/csv_downloads/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/csv_downloads/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/csv_downloads/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/csv_downloads/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/csv_downloads/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/csv_downloads/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/csv_downloads/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/csv_downloads/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/csv_downloads/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/csv_downloads/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/csv_downloads/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/csv_downloads/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/csv_downloads/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/csv_downloads/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/csv_downloads/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/csv_downloads/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/csv_downloads/:id
http GET {{baseUrl}}/phone_numbers/csv_downloads/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/csv_downloads/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/csv_downloads/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "csv_download",
"status": "pending",
"url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7"
}
]
}
GET
List call events
{{baseUrl}}/call_events
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/call_events");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/call_events")
require "http/client"
url = "{{baseUrl}}/call_events"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/call_events"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/call_events");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/call_events"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/call_events HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/call_events")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/call_events"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/call_events")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/call_events")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/call_events');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/call_events'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/call_events';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/call_events',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/call_events")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/call_events',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/call_events'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/call_events');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/call_events'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/call_events';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/call_events"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/call_events" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/call_events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/call_events');
echo $response->getBody();
setUrl('{{baseUrl}}/call_events');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/call_events');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/call_events' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/call_events' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/call_events")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/call_events"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/call_events"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/call_events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/call_events') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/call_events";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/call_events
http GET {{baseUrl}}/call_events
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/call_events
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/call_events")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"call_leg_id": "308fe500-5213-11e9-ace7-02420a0f0668",
"call_session_id": "308fec30-5213-11e9-9d3f-02420a0f0668",
"event_timestamp": "2019-03-29T11:10:19.127783Z",
"metadata": {},
"name": "call.hangup",
"record_type": "call_event",
"type": "webhook"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Search detail records
{{baseUrl}}/detail_records
QUERY PARAMS
filter[record_type]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/detail_records?filter%5Brecord_type%5D=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/detail_records" {:query-params {:filter[record_type] ""}})
require "http/client"
url = "{{baseUrl}}/detail_records?filter%5Brecord_type%5D="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/detail_records?filter%5Brecord_type%5D="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/detail_records?filter%5Brecord_type%5D=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/detail_records?filter%5Brecord_type%5D="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/detail_records?filter%5Brecord_type%5D= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/detail_records?filter%5Brecord_type%5D=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/detail_records?filter%5Brecord_type%5D="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/detail_records?filter%5Brecord_type%5D=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/detail_records?filter%5Brecord_type%5D=")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/detail_records?filter%5Brecord_type%5D=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/detail_records',
params: {'filter[record_type]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/detail_records?filter%5Brecord_type%5D=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/detail_records?filter%5Brecord_type%5D=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/detail_records?filter%5Brecord_type%5D=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/detail_records?filter%5Brecord_type%5D=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/detail_records',
qs: {'filter[record_type]': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/detail_records');
req.query({
'filter[record_type]': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/detail_records',
params: {'filter[record_type]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/detail_records?filter%5Brecord_type%5D=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/detail_records?filter%5Brecord_type%5D="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/detail_records?filter%5Brecord_type%5D=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/detail_records?filter%5Brecord_type%5D=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/detail_records?filter%5Brecord_type%5D=');
echo $response->getBody();
setUrl('{{baseUrl}}/detail_records');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'filter[record_type]' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/detail_records');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'filter[record_type]' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/detail_records?filter%5Brecord_type%5D=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/detail_records?filter%5Brecord_type%5D=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/detail_records?filter%5Brecord_type%5D=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/detail_records"
querystring = {"filter[record_type]":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/detail_records"
queryString <- list(filter[record_type] = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/detail_records?filter%5Brecord_type%5D=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/detail_records') do |req|
req.params['filter[record_type]'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/detail_records";
let querystring = [
("filter[record_type]", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/detail_records?filter%5Brecord_type%5D='
http GET '{{baseUrl}}/detail_records?filter%5Brecord_type%5D='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/detail_records?filter%5Brecord_type%5D='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/detail_records?filter%5Brecord_type%5D=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
DELETE
Delete a document
{{baseUrl}}/documents/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/documents/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/documents/:id")
require "http/client"
url = "{{baseUrl}}/documents/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/documents/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/documents/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/documents/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/documents/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/documents/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/documents/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/documents/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/documents/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/documents/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/documents/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/documents/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/documents/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/documents/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/documents/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/documents/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/documents/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/documents/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/documents/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/documents/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/documents/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/documents/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/documents/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/documents/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/documents/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/documents/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/documents/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/documents/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/documents/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/documents/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/documents/:id
http DELETE {{baseUrl}}/documents/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/documents/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download a document
{{baseUrl}}/documents/:id/download
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/documents/:id/download");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/documents/:id/download")
require "http/client"
url = "{{baseUrl}}/documents/:id/download"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/documents/:id/download"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/documents/:id/download");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/documents/:id/download"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/documents/:id/download HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/documents/:id/download")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/documents/:id/download"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/documents/:id/download")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/documents/:id/download")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/documents/:id/download');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/documents/:id/download'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/documents/:id/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/documents/:id/download',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/documents/:id/download")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/documents/:id/download',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/documents/:id/download'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/documents/:id/download');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/documents/:id/download'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/documents/:id/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/documents/:id/download"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/documents/:id/download" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/documents/:id/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/documents/:id/download');
echo $response->getBody();
setUrl('{{baseUrl}}/documents/:id/download');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/documents/:id/download');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/documents/:id/download' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/documents/:id/download' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/documents/:id/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/documents/:id/download"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/documents/:id/download"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/documents/:id/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/documents/:id/download') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/documents/:id/download";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/documents/:id/download
http GET {{baseUrl}}/documents/:id/download
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/documents/:id/download
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/documents/:id/download")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List all document links
{{baseUrl}}/document_links
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/document_links");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/document_links")
require "http/client"
url = "{{baseUrl}}/document_links"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/document_links"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/document_links");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/document_links"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/document_links HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/document_links")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/document_links"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/document_links")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/document_links")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/document_links');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/document_links'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/document_links';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/document_links',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/document_links")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/document_links',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/document_links'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/document_links');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/document_links'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/document_links';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/document_links"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/document_links" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/document_links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/document_links');
echo $response->getBody();
setUrl('{{baseUrl}}/document_links');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/document_links');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/document_links' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/document_links' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/document_links")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/document_links"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/document_links"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/document_links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/document_links') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/document_links";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/document_links
http GET {{baseUrl}}/document_links
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/document_links
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/document_links")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List all documents
{{baseUrl}}/documents
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/documents");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/documents")
require "http/client"
url = "{{baseUrl}}/documents"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/documents"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/documents");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/documents"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/documents HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/documents")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/documents"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/documents")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/documents")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/documents');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/documents'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/documents';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/documents',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/documents")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/documents',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/documents'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/documents');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/documents'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/documents';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/documents"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/documents" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/documents');
echo $response->getBody();
setUrl('{{baseUrl}}/documents');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/documents');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/documents' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/documents' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/documents")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/documents"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/documents"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/documents') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/documents";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/documents
http GET {{baseUrl}}/documents
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/documents
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/documents")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a document
{{baseUrl}}/documents/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/documents/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/documents/:id")
require "http/client"
url = "{{baseUrl}}/documents/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/documents/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/documents/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/documents/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/documents/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/documents/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/documents/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/documents/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/documents/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/documents/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/documents/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/documents/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/documents/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/documents/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/documents/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/documents/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/documents/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/documents/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/documents/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/documents/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/documents/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/documents/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/documents/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/documents/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/documents/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/documents/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/documents/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/documents/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/documents/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/documents/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/documents/:id
http GET {{baseUrl}}/documents/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/documents/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PATCH
Update a document
{{baseUrl}}/documents/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/documents/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/documents/:id")
require "http/client"
url = "{{baseUrl}}/documents/:id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/documents/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/documents/:id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/documents/:id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/documents/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/documents/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/documents/:id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/documents/:id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/documents/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/documents/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PATCH', url: '{{baseUrl}}/documents/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/documents/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/documents/:id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/documents/:id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/documents/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'PATCH', url: '{{baseUrl}}/documents/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/documents/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'PATCH', url: '{{baseUrl}}/documents/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/documents/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/documents/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/documents/:id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/documents/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/documents/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/documents/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/documents/:id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/documents/:id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/documents/:id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PATCH", "/baseUrl/documents/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/documents/:id"
response = requests.patch(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/documents/:id"
response <- VERB("PATCH", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/documents/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/documents/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/documents/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/documents/:id
http PATCH {{baseUrl}}/documents/:id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/documents/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/documents/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Upload a document
{{baseUrl}}/documents
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/documents");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/documents")
require "http/client"
url = "{{baseUrl}}/documents"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/documents"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/documents");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/documents"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/documents HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/documents")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/documents"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/documents")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/documents")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/documents');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/documents'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/documents';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/documents',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/documents")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/documents',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/documents'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/documents');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/documents'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/documents';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/documents"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/documents" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/documents');
echo $response->getBody();
setUrl('{{baseUrl}}/documents');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/documents');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/documents' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/documents' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/documents")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/documents"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/documents"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/documents') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/documents";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/documents
http POST {{baseUrl}}/documents
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/documents
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/documents")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create an FQDN connection
{{baseUrl}}/fqdn_connections
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdn_connections");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/fqdn_connections")
require "http/client"
url = "{{baseUrl}}/fqdn_connections"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/fqdn_connections"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdn_connections");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdn_connections"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/fqdn_connections HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/fqdn_connections")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdn_connections"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdn_connections")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/fqdn_connections")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/fqdn_connections');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/fqdn_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdn_connections';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdn_connections',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fqdn_connections")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdn_connections',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/fqdn_connections'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/fqdn_connections');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/fqdn_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdn_connections';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdn_connections"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdn_connections" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdn_connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/fqdn_connections');
echo $response->getBody();
setUrl('{{baseUrl}}/fqdn_connections');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fqdn_connections');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdn_connections' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdn_connections' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/fqdn_connections", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdn_connections"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdn_connections"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdn_connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/fqdn_connections') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdn_connections";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/fqdn_connections
http POST {{baseUrl}}/fqdn_connections
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/fqdn_connections
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdn_connections")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "1293384261075731499",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_routing_method": "sequential",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"record_type": "fqdn_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
DELETE
Delete an FQDN connection
{{baseUrl}}/fqdn_connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdn_connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/fqdn_connections/:id")
require "http/client"
url = "{{baseUrl}}/fqdn_connections/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/fqdn_connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdn_connections/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdn_connections/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/fqdn_connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/fqdn_connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdn_connections/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdn_connections/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/fqdn_connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/fqdn_connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/fqdn_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdn_connections/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdn_connections/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fqdn_connections/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdn_connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/fqdn_connections/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/fqdn_connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/fqdn_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdn_connections/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdn_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdn_connections/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdn_connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/fqdn_connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/fqdn_connections/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fqdn_connections/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdn_connections/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdn_connections/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/fqdn_connections/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdn_connections/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdn_connections/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdn_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/fqdn_connections/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdn_connections/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/fqdn_connections/:id
http DELETE {{baseUrl}}/fqdn_connections/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/fqdn_connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdn_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "1293384261075731499",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_routing_method": "sequential",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"record_type": "fqdn_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
GET
List FQDN connections
{{baseUrl}}/fqdn_connections
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdn_connections");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/fqdn_connections")
require "http/client"
url = "{{baseUrl}}/fqdn_connections"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/fqdn_connections"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdn_connections");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdn_connections"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/fqdn_connections HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/fqdn_connections")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdn_connections"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdn_connections")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/fqdn_connections")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/fqdn_connections');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/fqdn_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdn_connections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdn_connections',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fqdn_connections")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdn_connections',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/fqdn_connections'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/fqdn_connections');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/fqdn_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdn_connections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdn_connections"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdn_connections" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdn_connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/fqdn_connections');
echo $response->getBody();
setUrl('{{baseUrl}}/fqdn_connections');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fqdn_connections');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdn_connections' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdn_connections' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/fqdn_connections")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdn_connections"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdn_connections"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdn_connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/fqdn_connections') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdn_connections";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/fqdn_connections
http GET {{baseUrl}}/fqdn_connections
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/fqdn_connections
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdn_connections")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "1293384261075731499",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_routing_method": "sequential",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"record_type": "fqdn_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve an FQDN connection
{{baseUrl}}/fqdn_connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdn_connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/fqdn_connections/:id")
require "http/client"
url = "{{baseUrl}}/fqdn_connections/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/fqdn_connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdn_connections/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdn_connections/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/fqdn_connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/fqdn_connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdn_connections/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdn_connections/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/fqdn_connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/fqdn_connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/fqdn_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdn_connections/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdn_connections/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fqdn_connections/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdn_connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/fqdn_connections/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/fqdn_connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/fqdn_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdn_connections/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdn_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdn_connections/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdn_connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/fqdn_connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/fqdn_connections/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fqdn_connections/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdn_connections/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdn_connections/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/fqdn_connections/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdn_connections/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdn_connections/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdn_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/fqdn_connections/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdn_connections/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/fqdn_connections/:id
http GET {{baseUrl}}/fqdn_connections/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/fqdn_connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdn_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "1293384261075731499",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_routing_method": "sequential",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"record_type": "fqdn_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
PATCH
Update an FQDN connection
{{baseUrl}}/fqdn_connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdn_connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/fqdn_connections/:id")
require "http/client"
url = "{{baseUrl}}/fqdn_connections/:id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/fqdn_connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdn_connections/:id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdn_connections/:id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/fqdn_connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/fqdn_connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdn_connections/:id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdn_connections/:id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/fqdn_connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/fqdn_connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PATCH', url: '{{baseUrl}}/fqdn_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdn_connections/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdn_connections/:id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fqdn_connections/:id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdn_connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'PATCH', url: '{{baseUrl}}/fqdn_connections/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/fqdn_connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'PATCH', url: '{{baseUrl}}/fqdn_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdn_connections/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdn_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdn_connections/:id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdn_connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/fqdn_connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/fqdn_connections/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fqdn_connections/:id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdn_connections/:id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdn_connections/:id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("PATCH", "/baseUrl/fqdn_connections/:id", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdn_connections/:id"
payload = ""
response = requests.patch(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdn_connections/:id"
payload <- ""
response <- VERB("PATCH", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdn_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/fqdn_connections/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdn_connections/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/fqdn_connections/:id
http PATCH {{baseUrl}}/fqdn_connections/:id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/fqdn_connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdn_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "1293384261075731499",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_routing_method": "sequential",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"record_type": "fqdn_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
POST
Create an FQDN
{{baseUrl}}/fqdns
BODY json
{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdns");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/fqdns" {:content-type :json
:form-params {:connection_id ""
:dns_record_type ""
:fqdn ""
:port 0}})
require "http/client"
url = "{{baseUrl}}/fqdns"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/fqdns"),
Content = new StringContent("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdns");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdns"
payload := strings.NewReader("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/fqdns HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 77
{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/fqdns")
.setHeader("content-type", "application/json")
.setBody("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdns"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdns")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/fqdns")
.header("content-type", "application/json")
.body("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
.asString();
const data = JSON.stringify({
connection_id: '',
dns_record_type: '',
fqdn: '',
port: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/fqdns');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/fqdns',
headers: {'content-type': 'application/json'},
data: {connection_id: '', dns_record_type: '', fqdn: '', port: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdns';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","dns_record_type":"","fqdn":"","port":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdns',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "connection_id": "",\n "dns_record_type": "",\n "fqdn": "",\n "port": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/fqdns")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdns',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({connection_id: '', dns_record_type: '', fqdn: '', port: 0}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/fqdns',
headers: {'content-type': 'application/json'},
body: {connection_id: '', dns_record_type: '', fqdn: '', port: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/fqdns');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
connection_id: '',
dns_record_type: '',
fqdn: '',
port: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/fqdns',
headers: {'content-type': 'application/json'},
data: {connection_id: '', dns_record_type: '', fqdn: '', port: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdns';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","dns_record_type":"","fqdn":"","port":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"connection_id": @"",
@"dns_record_type": @"",
@"fqdn": @"",
@"port": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdns"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdns" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdns",
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([
'connection_id' => '',
'dns_record_type' => '',
'fqdn' => '',
'port' => 0
]),
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;
}
request('POST', '{{baseUrl}}/fqdns', [
'body' => '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/fqdns');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'connection_id' => '',
'dns_record_type' => '',
'fqdn' => '',
'port' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'connection_id' => '',
'dns_record_type' => '',
'fqdn' => '',
'port' => 0
]));
$request->setRequestUrl('{{baseUrl}}/fqdns');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdns' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdns' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/fqdns", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdns"
payload = {
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdns"
payload <- "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdns")
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 \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/fqdns') do |req|
req.body = "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdns";
let payload = json!({
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/fqdns \
--header 'content-type: application/json' \
--data '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}'
echo '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}' | \
http POST {{baseUrl}}/fqdns \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "connection_id": "",\n "dns_record_type": "",\n "fqdn": "",\n "port": 0\n}' \
--output-document \
- {{baseUrl}}/fqdns
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdns")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "1516447646313612565",
"created_at": "2018-02-02T22:25:27.521Z",
"dns_record_type": "a",
"fqdn": "example.com",
"id": "1293384261075731499",
"port": 5060,
"record_type": "fqdn",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
DELETE
Delete an FQDN
{{baseUrl}}/fqdns/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdns/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/fqdns/:id")
require "http/client"
url = "{{baseUrl}}/fqdns/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/fqdns/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdns/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdns/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/fqdns/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/fqdns/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdns/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdns/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/fqdns/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/fqdns/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/fqdns/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdns/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdns/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fqdns/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdns/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/fqdns/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/fqdns/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/fqdns/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdns/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdns/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdns/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdns/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/fqdns/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/fqdns/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fqdns/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdns/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdns/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/fqdns/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdns/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdns/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdns/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/fqdns/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdns/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/fqdns/:id
http DELETE {{baseUrl}}/fqdns/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/fqdns/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdns/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "1516447646313612565",
"created_at": "2018-02-02T22:25:27.521Z",
"dns_record_type": "a",
"fqdn": "example.com",
"id": "1293384261075731499",
"port": 5060,
"record_type": "fqdn",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
List FQDNs
{{baseUrl}}/fqdns
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdns");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/fqdns")
require "http/client"
url = "{{baseUrl}}/fqdns"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/fqdns"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdns");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdns"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/fqdns HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/fqdns")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdns"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdns")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/fqdns")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/fqdns');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/fqdns'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdns';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdns',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fqdns")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdns',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/fqdns'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/fqdns');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/fqdns'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdns';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdns"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdns" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/fqdns');
echo $response->getBody();
setUrl('{{baseUrl}}/fqdns');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fqdns');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdns' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdns' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/fqdns")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdns"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdns"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/fqdns') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdns";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/fqdns
http GET {{baseUrl}}/fqdns
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/fqdns
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdns")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"connection_id": "1516447646313612565",
"created_at": "2018-02-02T22:25:27.521Z",
"dns_record_type": "a",
"fqdn": "example.com",
"id": "1293384261075731499",
"port": 5060,
"record_type": "fqdn",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve an FQDN
{{baseUrl}}/fqdns/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdns/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/fqdns/:id")
require "http/client"
url = "{{baseUrl}}/fqdns/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/fqdns/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdns/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdns/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/fqdns/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/fqdns/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdns/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdns/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/fqdns/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/fqdns/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/fqdns/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdns/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdns/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fqdns/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdns/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/fqdns/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/fqdns/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/fqdns/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdns/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdns/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdns/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdns/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/fqdns/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/fqdns/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fqdns/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdns/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdns/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/fqdns/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdns/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdns/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdns/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/fqdns/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdns/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/fqdns/:id
http GET {{baseUrl}}/fqdns/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/fqdns/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdns/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "1516447646313612565",
"created_at": "2018-02-02T22:25:27.521Z",
"dns_record_type": "a",
"fqdn": "example.com",
"id": "1293384261075731499",
"port": 5060,
"record_type": "fqdn",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
PATCH
Update an FQDN
{{baseUrl}}/fqdns/:id
QUERY PARAMS
id
BODY json
{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fqdns/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/fqdns/:id" {:content-type :json
:form-params {:connection_id ""
:dns_record_type ""
:fqdn ""
:port 0}})
require "http/client"
url = "{{baseUrl}}/fqdns/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/fqdns/:id"),
Content = new StringContent("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fqdns/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fqdns/:id"
payload := strings.NewReader("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/fqdns/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 77
{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/fqdns/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fqdns/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/fqdns/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/fqdns/:id")
.header("content-type", "application/json")
.body("{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
.asString();
const data = JSON.stringify({
connection_id: '',
dns_record_type: '',
fqdn: '',
port: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/fqdns/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/fqdns/:id',
headers: {'content-type': 'application/json'},
data: {connection_id: '', dns_record_type: '', fqdn: '', port: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fqdns/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","dns_record_type":"","fqdn":"","port":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fqdns/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "connection_id": "",\n "dns_record_type": "",\n "fqdn": "",\n "port": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/fqdns/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/fqdns/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({connection_id: '', dns_record_type: '', fqdn: '', port: 0}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/fqdns/:id',
headers: {'content-type': 'application/json'},
body: {connection_id: '', dns_record_type: '', fqdn: '', port: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/fqdns/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
connection_id: '',
dns_record_type: '',
fqdn: '',
port: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/fqdns/:id',
headers: {'content-type': 'application/json'},
data: {connection_id: '', dns_record_type: '', fqdn: '', port: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fqdns/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","dns_record_type":"","fqdn":"","port":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"connection_id": @"",
@"dns_record_type": @"",
@"fqdn": @"",
@"port": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fqdns/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fqdns/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fqdns/:id",
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([
'connection_id' => '',
'dns_record_type' => '',
'fqdn' => '',
'port' => 0
]),
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;
}
request('PATCH', '{{baseUrl}}/fqdns/:id', [
'body' => '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/fqdns/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'connection_id' => '',
'dns_record_type' => '',
'fqdn' => '',
'port' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'connection_id' => '',
'dns_record_type' => '',
'fqdn' => '',
'port' => 0
]));
$request->setRequestUrl('{{baseUrl}}/fqdns/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fqdns/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fqdns/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/fqdns/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fqdns/:id"
payload = {
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fqdns/:id"
payload <- "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fqdns/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/fqdns/:id') do |req|
req.body = "{\n \"connection_id\": \"\",\n \"dns_record_type\": \"\",\n \"fqdn\": \"\",\n \"port\": 0\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fqdns/:id";
let payload = json!({
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/fqdns/:id \
--header 'content-type: application/json' \
--data '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}'
echo '{
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
}' | \
http PATCH {{baseUrl}}/fqdns/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "connection_id": "",\n "dns_record_type": "",\n "fqdn": "",\n "port": 0\n}' \
--output-document \
- {{baseUrl}}/fqdns/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"connection_id": "",
"dns_record_type": "",
"fqdn": "",
"port": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fqdns/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "1516447646313612565",
"created_at": "2018-02-02T22:25:27.521Z",
"dns_record_type": "a",
"fqdn": "example.com",
"id": "1293384261075731499",
"port": 5060,
"record_type": "fqdn",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Retrieve your inbound channels
{{baseUrl}}/phone_numbers/inbound_channels
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/inbound_channels");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/inbound_channels")
require "http/client"
url = "{{baseUrl}}/phone_numbers/inbound_channels"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/inbound_channels"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/inbound_channels");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/inbound_channels"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/inbound_channels HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/inbound_channels")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/inbound_channels"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/inbound_channels")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/inbound_channels")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/inbound_channels');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/phone_numbers/inbound_channels'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/inbound_channels';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/inbound_channels',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/inbound_channels")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/inbound_channels',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/phone_numbers/inbound_channels'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/inbound_channels');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/phone_numbers/inbound_channels'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/inbound_channels';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/inbound_channels"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/inbound_channels" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/inbound_channels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/inbound_channels');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/inbound_channels');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/inbound_channels');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/inbound_channels' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/inbound_channels' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/inbound_channels")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/inbound_channels"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/inbound_channels"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/inbound_channels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/inbound_channels') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/inbound_channels";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/inbound_channels
http GET {{baseUrl}}/phone_numbers/inbound_channels
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/inbound_channels
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/inbound_channels")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"channels": 7,
"record_type": "inbound_channels"
}
}
PATCH
Update inbound channels
{{baseUrl}}/phone_numbers/inbound_channels
BODY json
{
"channels": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/inbound_channels");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"channels\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/phone_numbers/inbound_channels" {:content-type :json
:form-params {:channels 0}})
require "http/client"
url = "{{baseUrl}}/phone_numbers/inbound_channels"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"channels\": 0\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/inbound_channels"),
Content = new StringContent("{\n \"channels\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/inbound_channels");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"channels\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/inbound_channels"
payload := strings.NewReader("{\n \"channels\": 0\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/phone_numbers/inbound_channels HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 19
{
"channels": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/phone_numbers/inbound_channels")
.setHeader("content-type", "application/json")
.setBody("{\n \"channels\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/inbound_channels"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"channels\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"channels\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/inbound_channels")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/phone_numbers/inbound_channels")
.header("content-type", "application/json")
.body("{\n \"channels\": 0\n}")
.asString();
const data = JSON.stringify({
channels: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/phone_numbers/inbound_channels');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/inbound_channels',
headers: {'content-type': 'application/json'},
data: {channels: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/inbound_channels';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"channels":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/inbound_channels',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "channels": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"channels\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/inbound_channels")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/inbound_channels',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({channels: 0}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/inbound_channels',
headers: {'content-type': 'application/json'},
body: {channels: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/phone_numbers/inbound_channels');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
channels: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/inbound_channels',
headers: {'content-type': 'application/json'},
data: {channels: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/inbound_channels';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"channels":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"channels": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/inbound_channels"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/inbound_channels" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"channels\": 0\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/inbound_channels",
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([
'channels' => 0
]),
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;
}
request('PATCH', '{{baseUrl}}/phone_numbers/inbound_channels', [
'body' => '{
"channels": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/inbound_channels');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'channels' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'channels' => 0
]));
$request->setRequestUrl('{{baseUrl}}/phone_numbers/inbound_channels');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/inbound_channels' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"channels": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/inbound_channels' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"channels": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"channels\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/phone_numbers/inbound_channels", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/inbound_channels"
payload = { "channels": 0 }
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/inbound_channels"
payload <- "{\n \"channels\": 0\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/inbound_channels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"channels\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/phone_numbers/inbound_channels') do |req|
req.body = "{\n \"channels\": 0\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/inbound_channels";
let payload = json!({"channels": 0});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/phone_numbers/inbound_channels \
--header 'content-type: application/json' \
--data '{
"channels": 0
}'
echo '{
"channels": 0
}' | \
http PATCH {{baseUrl}}/phone_numbers/inbound_channels \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "channels": 0\n}' \
--output-document \
- {{baseUrl}}/phone_numbers/inbound_channels
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["channels": 0] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/inbound_channels")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"channels": 7,
"record_type": "inbound_channels"
}
}
GET
Create an inventory coverage request
{{baseUrl}}/inventory_coverage
QUERY PARAMS
filter[groupBy]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/inventory_coverage" {:query-params {:filter[groupBy] ""}})
require "http/client"
url = "{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/inventory_coverage?filter%5BgroupBy%5D= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/inventory_coverage',
params: {'filter[groupBy]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/inventory_coverage?filter%5BgroupBy%5D=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/inventory_coverage',
qs: {'filter[groupBy]': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/inventory_coverage');
req.query({
'filter[groupBy]': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/inventory_coverage',
params: {'filter[groupBy]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=');
echo $response->getBody();
setUrl('{{baseUrl}}/inventory_coverage');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'filter[groupBy]' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/inventory_coverage');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'filter[groupBy]' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/inventory_coverage?filter%5BgroupBy%5D=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/inventory_coverage"
querystring = {"filter[groupBy]":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/inventory_coverage"
queryString <- list(filter[groupBy] = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/inventory_coverage') do |req|
req.params['filter[groupBy]'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/inventory_coverage";
let querystring = [
("filter[groupBy]", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D='
http GET '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/inventory_coverage?filter%5BgroupBy%5D=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"count": 3,
"coverage_type": "number",
"group": "318",
"group_type": "npa",
"number_range": 1,
"number_type": "did",
"phone_number_type": "local",
"record_type": "inventory_coverage_group"
}
],
"meta": {
"total_results": 25
}
}
POST
Create an Ip connection
{{baseUrl}}/ip_connections
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ip_connections");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/ip_connections")
require "http/client"
url = "{{baseUrl}}/ip_connections"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/ip_connections"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ip_connections");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ip_connections"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/ip_connections HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/ip_connections")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ip_connections"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ip_connections")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/ip_connections")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/ip_connections');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/ip_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ip_connections';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ip_connections',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ip_connections")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/ip_connections',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/ip_connections'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/ip_connections');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/ip_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ip_connections';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ip_connections"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ip_connections" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ip_connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/ip_connections');
echo $response->getBody();
setUrl('{{baseUrl}}/ip_connections');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ip_connections');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ip_connections' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ip_connections' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/ip_connections", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ip_connections"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ip_connections"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ip_connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/ip_connections') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ip_connections";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/ip_connections
http POST {{baseUrl}}/ip_connections
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/ip_connections
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ip_connections")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_primary_ip_id": "192.0.2.1",
"default_routing_method": "sequential",
"default_secondary_ip_id": "198.51.100.1",
"default_tertiary_ip_id": "203.0.113.1",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"ip_authentication_method": "token",
"ip_authentication_token": "string",
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx",
"tech_prefix": "string"
},
"record_type": "ip_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
DELETE
Delete an Ip connection
{{baseUrl}}/ip_connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ip_connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/ip_connections/:id")
require "http/client"
url = "{{baseUrl}}/ip_connections/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/ip_connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ip_connections/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ip_connections/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/ip_connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/ip_connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ip_connections/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ip_connections/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/ip_connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/ip_connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/ip_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ip_connections/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ip_connections/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ip_connections/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/ip_connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/ip_connections/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/ip_connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/ip_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ip_connections/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ip_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ip_connections/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ip_connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/ip_connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/ip_connections/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ip_connections/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ip_connections/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ip_connections/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/ip_connections/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ip_connections/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ip_connections/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ip_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/ip_connections/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ip_connections/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/ip_connections/:id
http DELETE {{baseUrl}}/ip_connections/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/ip_connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ip_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_primary_ip_id": "192.0.2.1",
"default_routing_method": "sequential",
"default_secondary_ip_id": "198.51.100.1",
"default_tertiary_ip_id": "203.0.113.1",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"ip_authentication_method": "token",
"ip_authentication_token": "string",
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx",
"tech_prefix": "string"
},
"record_type": "ip_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
GET
List Ip connections
{{baseUrl}}/ip_connections
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ip_connections");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/ip_connections")
require "http/client"
url = "{{baseUrl}}/ip_connections"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/ip_connections"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ip_connections");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ip_connections"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/ip_connections HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/ip_connections")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ip_connections"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ip_connections")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/ip_connections")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/ip_connections');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/ip_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ip_connections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ip_connections',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ip_connections")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/ip_connections',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/ip_connections'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/ip_connections');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/ip_connections'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ip_connections';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ip_connections"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ip_connections" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ip_connections",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/ip_connections');
echo $response->getBody();
setUrl('{{baseUrl}}/ip_connections');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ip_connections');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ip_connections' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ip_connections' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/ip_connections")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ip_connections"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ip_connections"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ip_connections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/ip_connections') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ip_connections";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/ip_connections
http GET {{baseUrl}}/ip_connections
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/ip_connections
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ip_connections")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_primary_ip_id": "192.0.2.1",
"default_routing_method": "sequential",
"default_secondary_ip_id": "198.51.100.1",
"default_tertiary_ip_id": "203.0.113.1",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"ip_authentication_method": "token",
"ip_authentication_token": "string",
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx",
"tech_prefix": "string"
},
"record_type": "ip_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve an Ip connection
{{baseUrl}}/ip_connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ip_connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/ip_connections/:id")
require "http/client"
url = "{{baseUrl}}/ip_connections/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/ip_connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ip_connections/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ip_connections/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/ip_connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/ip_connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ip_connections/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ip_connections/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/ip_connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/ip_connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/ip_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ip_connections/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ip_connections/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ip_connections/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/ip_connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/ip_connections/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/ip_connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/ip_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ip_connections/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ip_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ip_connections/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ip_connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/ip_connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/ip_connections/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ip_connections/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ip_connections/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ip_connections/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/ip_connections/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ip_connections/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ip_connections/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ip_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/ip_connections/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ip_connections/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/ip_connections/:id
http GET {{baseUrl}}/ip_connections/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/ip_connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ip_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_primary_ip_id": "192.0.2.1",
"default_routing_method": "sequential",
"default_secondary_ip_id": "198.51.100.1",
"default_tertiary_ip_id": "203.0.113.1",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"ip_authentication_method": "token",
"ip_authentication_token": "string",
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx",
"tech_prefix": "string"
},
"record_type": "ip_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
PATCH
Update an Ip connection
{{baseUrl}}/ip_connections/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ip_connections/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/ip_connections/:id")
require "http/client"
url = "{{baseUrl}}/ip_connections/:id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/ip_connections/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ip_connections/:id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ip_connections/:id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/ip_connections/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/ip_connections/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ip_connections/:id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ip_connections/:id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/ip_connections/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/ip_connections/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PATCH', url: '{{baseUrl}}/ip_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ip_connections/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ip_connections/:id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ip_connections/:id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/ip_connections/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'PATCH', url: '{{baseUrl}}/ip_connections/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/ip_connections/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'PATCH', url: '{{baseUrl}}/ip_connections/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ip_connections/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ip_connections/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ip_connections/:id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ip_connections/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/ip_connections/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/ip_connections/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ip_connections/:id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ip_connections/:id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ip_connections/:id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("PATCH", "/baseUrl/ip_connections/:id", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ip_connections/:id"
payload = ""
response = requests.patch(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ip_connections/:id"
payload <- ""
response <- VERB("PATCH", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ip_connections/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/ip_connections/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ip_connections/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/ip_connections/:id
http PATCH {{baseUrl}}/ip_connections/:id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/ip_connections/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ip_connections/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": true,
"anchorsite_override": "Latency",
"connection_name": "string",
"created_at": "2018-02-02T22:25:27.521Z",
"default_on_hold_comfort_noise_enabled": true,
"dtmf_type": "RFC 2833",
"encode_contact_header_enabled": true,
"encrypted_media": "SRTP",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"inbound": {
"ani_number_format": "+E.164",
"channel_limit": 10,
"codecs": [
"G722"
],
"default_primary_ip_id": "192.0.2.1",
"default_routing_method": "sequential",
"default_secondary_ip_id": "198.51.100.1",
"default_tertiary_ip_id": "203.0.113.1",
"dnis_number_format": "+e164",
"generate_ringback_tone": true,
"isup_headers_enabled": true,
"prack_enabled": true,
"privacy_zone_enabled": true,
"sip_compact_headers_enabled": true,
"sip_region": "US",
"sip_subdomain": "string",
"sip_subdomain_receive_settings": "only_my_connections",
"timeout_1xx_secs": 10,
"timeout_2xx_secs": 10
},
"onnet_t38_passthrough_enabled": true,
"outbound": {
"ani_override": "string",
"ani_override_type": "always",
"call_parking_enabled": true,
"channel_limit": 10,
"generate_ringback_tone": true,
"instant_ringback_enabled": true,
"ip_authentication_method": "token",
"ip_authentication_token": "string",
"localization": "string",
"outbound_voice_profile_id": "1293384261075731499",
"t38_reinvite_source": "telnyx",
"tech_prefix": "string"
},
"record_type": "ip_connection",
"rtcp_settings": {
"capture_enabled": true,
"port": "rtcp-mux",
"report_frequency_secs": 10
},
"transport_protocol": "UDP",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_api_version": "1",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
POST
Create an Ip
{{baseUrl}}/ips
BODY json
{
"connection_id": "",
"ip_address": "",
"port": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ips");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/ips" {:content-type :json
:form-params {:connection_id ""
:ip_address ""
:port 0}})
require "http/client"
url = "{{baseUrl}}/ips"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/ips"),
Content = new StringContent("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ips");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ips"
payload := strings.NewReader("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/ips HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 58
{
"connection_id": "",
"ip_address": "",
"port": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/ips")
.setHeader("content-type", "application/json")
.setBody("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ips"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/ips")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/ips")
.header("content-type", "application/json")
.body("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
.asString();
const data = JSON.stringify({
connection_id: '',
ip_address: '',
port: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/ips');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/ips',
headers: {'content-type': 'application/json'},
data: {connection_id: '', ip_address: '', port: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ips';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","ip_address":"","port":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ips',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "connection_id": "",\n "ip_address": "",\n "port": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/ips")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/ips',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({connection_id: '', ip_address: '', port: 0}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/ips',
headers: {'content-type': 'application/json'},
body: {connection_id: '', ip_address: '', port: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/ips');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
connection_id: '',
ip_address: '',
port: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/ips',
headers: {'content-type': 'application/json'},
data: {connection_id: '', ip_address: '', port: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ips';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","ip_address":"","port":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"connection_id": @"",
@"ip_address": @"",
@"port": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ips"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ips" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ips",
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([
'connection_id' => '',
'ip_address' => '',
'port' => 0
]),
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;
}
request('POST', '{{baseUrl}}/ips', [
'body' => '{
"connection_id": "",
"ip_address": "",
"port": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/ips');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'connection_id' => '',
'ip_address' => '',
'port' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'connection_id' => '',
'ip_address' => '',
'port' => 0
]));
$request->setRequestUrl('{{baseUrl}}/ips');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ips' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"ip_address": "",
"port": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ips' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"ip_address": "",
"port": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/ips", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ips"
payload = {
"connection_id": "",
"ip_address": "",
"port": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ips"
payload <- "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ips")
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 \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/ips') do |req|
req.body = "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ips";
let payload = json!({
"connection_id": "",
"ip_address": "",
"port": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/ips \
--header 'content-type: application/json' \
--data '{
"connection_id": "",
"ip_address": "",
"port": 0
}'
echo '{
"connection_id": "",
"ip_address": "",
"port": 0
}' | \
http POST {{baseUrl}}/ips \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "connection_id": "",\n "ip_address": "",\n "port": 0\n}' \
--output-document \
- {{baseUrl}}/ips
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"connection_id": "",
"ip_address": "",
"port": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ips")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "3456789987654",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"ip_address": "192.168.0.0",
"port": 5060,
"record_type": "ip",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
DELETE
Delete an Ip
{{baseUrl}}/ips/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ips/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/ips/:id")
require "http/client"
url = "{{baseUrl}}/ips/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/ips/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ips/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ips/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/ips/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/ips/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ips/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ips/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/ips/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/ips/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/ips/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ips/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ips/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ips/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/ips/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/ips/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/ips/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/ips/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ips/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ips/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ips/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ips/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/ips/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/ips/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ips/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ips/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ips/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/ips/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ips/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ips/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ips/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/ips/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ips/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/ips/:id
http DELETE {{baseUrl}}/ips/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/ips/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ips/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "3456789987654",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"ip_address": "192.168.0.0",
"port": 5060,
"record_type": "ip",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
List Ips
{{baseUrl}}/ips
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ips");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/ips")
require "http/client"
url = "{{baseUrl}}/ips"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/ips"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ips");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ips"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/ips HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/ips")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ips"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ips")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/ips")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/ips');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/ips'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ips';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ips',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ips")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/ips',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/ips'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/ips');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/ips'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ips';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ips"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ips" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ips",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/ips');
echo $response->getBody();
setUrl('{{baseUrl}}/ips');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ips');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ips' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ips' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/ips")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ips"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ips"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ips")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/ips') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ips";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/ips
http GET {{baseUrl}}/ips
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/ips
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ips")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"connection_id": "3456789987654",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"ip_address": "192.168.0.0",
"port": 5060,
"record_type": "ip",
"updated_at": "2018-02-02T22:25:27.521Z"
}
]
}
GET
Retrieve an Ip
{{baseUrl}}/ips/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ips/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/ips/:id")
require "http/client"
url = "{{baseUrl}}/ips/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/ips/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ips/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ips/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/ips/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/ips/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ips/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ips/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/ips/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/ips/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/ips/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ips/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ips/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ips/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/ips/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/ips/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/ips/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/ips/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ips/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ips/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ips/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ips/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/ips/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/ips/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ips/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ips/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ips/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/ips/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ips/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ips/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ips/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/ips/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ips/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/ips/:id
http GET {{baseUrl}}/ips/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/ips/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ips/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "3456789987654",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"ip_address": "192.168.0.0",
"port": 5060,
"record_type": "ip",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
PATCH
Update an Ip
{{baseUrl}}/ips/:id
QUERY PARAMS
id
BODY json
{
"connection_id": "",
"ip_address": "",
"port": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ips/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/ips/:id" {:content-type :json
:form-params {:connection_id ""
:ip_address ""
:port 0}})
require "http/client"
url = "{{baseUrl}}/ips/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/ips/:id"),
Content = new StringContent("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ips/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ips/:id"
payload := strings.NewReader("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/ips/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 58
{
"connection_id": "",
"ip_address": "",
"port": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/ips/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ips/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/ips/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/ips/:id")
.header("content-type", "application/json")
.body("{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
.asString();
const data = JSON.stringify({
connection_id: '',
ip_address: '',
port: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/ips/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/ips/:id',
headers: {'content-type': 'application/json'},
data: {connection_id: '', ip_address: '', port: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ips/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","ip_address":"","port":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ips/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "connection_id": "",\n "ip_address": "",\n "port": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/ips/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/ips/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({connection_id: '', ip_address: '', port: 0}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/ips/:id',
headers: {'content-type': 'application/json'},
body: {connection_id: '', ip_address: '', port: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/ips/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
connection_id: '',
ip_address: '',
port: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/ips/:id',
headers: {'content-type': 'application/json'},
data: {connection_id: '', ip_address: '', port: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ips/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","ip_address":"","port":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"connection_id": @"",
@"ip_address": @"",
@"port": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ips/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ips/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ips/:id",
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([
'connection_id' => '',
'ip_address' => '',
'port' => 0
]),
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;
}
request('PATCH', '{{baseUrl}}/ips/:id', [
'body' => '{
"connection_id": "",
"ip_address": "",
"port": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/ips/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'connection_id' => '',
'ip_address' => '',
'port' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'connection_id' => '',
'ip_address' => '',
'port' => 0
]));
$request->setRequestUrl('{{baseUrl}}/ips/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ips/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"ip_address": "",
"port": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ips/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"ip_address": "",
"port": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/ips/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ips/:id"
payload = {
"connection_id": "",
"ip_address": "",
"port": 0
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ips/:id"
payload <- "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ips/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/ips/:id') do |req|
req.body = "{\n \"connection_id\": \"\",\n \"ip_address\": \"\",\n \"port\": 0\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ips/:id";
let payload = json!({
"connection_id": "",
"ip_address": "",
"port": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/ips/:id \
--header 'content-type: application/json' \
--data '{
"connection_id": "",
"ip_address": "",
"port": 0
}'
echo '{
"connection_id": "",
"ip_address": "",
"port": 0
}' | \
http PATCH {{baseUrl}}/ips/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "connection_id": "",\n "ip_address": "",\n "port": 0\n}' \
--output-document \
- {{baseUrl}}/ips/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"connection_id": "",
"ip_address": "",
"port": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ips/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "3456789987654",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"ip_address": "192.168.0.0",
"port": 5060,
"record_type": "ip",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Create a new managed account.
{{baseUrl}}/managed_accounts
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/managed_accounts");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/managed_accounts")
require "http/client"
url = "{{baseUrl}}/managed_accounts"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/managed_accounts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/managed_accounts");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/managed_accounts"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/managed_accounts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/managed_accounts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/managed_accounts"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/managed_accounts")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/managed_accounts")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/managed_accounts');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/managed_accounts'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/managed_accounts';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/managed_accounts',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/managed_accounts")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/managed_accounts',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/managed_accounts'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/managed_accounts');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/managed_accounts'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/managed_accounts';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/managed_accounts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/managed_accounts" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/managed_accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/managed_accounts');
echo $response->getBody();
setUrl('{{baseUrl}}/managed_accounts');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/managed_accounts');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/managed_accounts' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/managed_accounts' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/managed_accounts", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/managed_accounts"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/managed_accounts"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/managed_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/managed_accounts') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/managed_accounts";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/managed_accounts
http POST {{baseUrl}}/managed_accounts
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/managed_accounts
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/managed_accounts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"api_key": "KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu",
"api_token": "x6oexQNHTs-fZ7-QsDMOeg",
"api_user": "managed_account@example.com",
"balance": {
"available_credit": "400.00",
"balance": "300.00",
"credit_limit": "100.00",
"currency": "USD",
"record_type": "balance"
},
"created_at": "2018-02-02T22:25:27.521Z",
"email": "user@example.com",
"id": "f65ceda4-6522-4ad6-aede-98de83385123",
"manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
"organization_name": "Example Company LLC",
"record_type": "managed_account",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Disables a managed account
{{baseUrl}}/managed_accounts/:id/actions/disable
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/managed_accounts/:id/actions/disable");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/managed_accounts/:id/actions/disable")
require "http/client"
url = "{{baseUrl}}/managed_accounts/:id/actions/disable"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/managed_accounts/:id/actions/disable"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/managed_accounts/:id/actions/disable");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/managed_accounts/:id/actions/disable"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/managed_accounts/:id/actions/disable HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/managed_accounts/:id/actions/disable")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/managed_accounts/:id/actions/disable"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/managed_accounts/:id/actions/disable")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/managed_accounts/:id/actions/disable")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/managed_accounts/:id/actions/disable');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/managed_accounts/:id/actions/disable'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/managed_accounts/:id/actions/disable';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/managed_accounts/:id/actions/disable',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/managed_accounts/:id/actions/disable")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/managed_accounts/:id/actions/disable',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/managed_accounts/:id/actions/disable'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/managed_accounts/:id/actions/disable');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/managed_accounts/:id/actions/disable'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/managed_accounts/:id/actions/disable';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/managed_accounts/:id/actions/disable"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/managed_accounts/:id/actions/disable" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/managed_accounts/:id/actions/disable",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/managed_accounts/:id/actions/disable');
echo $response->getBody();
setUrl('{{baseUrl}}/managed_accounts/:id/actions/disable');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/managed_accounts/:id/actions/disable');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/managed_accounts/:id/actions/disable' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/managed_accounts/:id/actions/disable' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/managed_accounts/:id/actions/disable")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/managed_accounts/:id/actions/disable"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/managed_accounts/:id/actions/disable"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/managed_accounts/:id/actions/disable")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/managed_accounts/:id/actions/disable') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/managed_accounts/:id/actions/disable";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/managed_accounts/:id/actions/disable
http POST {{baseUrl}}/managed_accounts/:id/actions/disable
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/managed_accounts/:id/actions/disable
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/managed_accounts/:id/actions/disable")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"api_key": "KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu",
"api_token": "x6oexQNHTs-fZ7-QsDMOeg",
"api_user": "managed_account@example.com",
"balance": {
"available_credit": "400.00",
"balance": "300.00",
"credit_limit": "100.00",
"currency": "USD",
"record_type": "balance"
},
"created_at": "2018-02-02T22:25:27.521Z",
"email": "user@example.com",
"id": "f65ceda4-6522-4ad6-aede-98de83385123",
"manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
"organization_name": "Example Company LLC",
"record_type": "managed_account",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Enables a managed account
{{baseUrl}}/managed_accounts/:id/actions/enable
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/managed_accounts/:id/actions/enable");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/managed_accounts/:id/actions/enable")
require "http/client"
url = "{{baseUrl}}/managed_accounts/:id/actions/enable"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/managed_accounts/:id/actions/enable"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/managed_accounts/:id/actions/enable");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/managed_accounts/:id/actions/enable"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/managed_accounts/:id/actions/enable HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/managed_accounts/:id/actions/enable")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/managed_accounts/:id/actions/enable"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/managed_accounts/:id/actions/enable")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/managed_accounts/:id/actions/enable")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/managed_accounts/:id/actions/enable');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/managed_accounts/:id/actions/enable'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/managed_accounts/:id/actions/enable';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/managed_accounts/:id/actions/enable',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/managed_accounts/:id/actions/enable")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/managed_accounts/:id/actions/enable',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/managed_accounts/:id/actions/enable'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/managed_accounts/:id/actions/enable');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/managed_accounts/:id/actions/enable'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/managed_accounts/:id/actions/enable';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/managed_accounts/:id/actions/enable"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/managed_accounts/:id/actions/enable" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/managed_accounts/:id/actions/enable",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/managed_accounts/:id/actions/enable');
echo $response->getBody();
setUrl('{{baseUrl}}/managed_accounts/:id/actions/enable');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/managed_accounts/:id/actions/enable');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/managed_accounts/:id/actions/enable' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/managed_accounts/:id/actions/enable' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/managed_accounts/:id/actions/enable")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/managed_accounts/:id/actions/enable"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/managed_accounts/:id/actions/enable"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/managed_accounts/:id/actions/enable")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/managed_accounts/:id/actions/enable') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/managed_accounts/:id/actions/enable";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/managed_accounts/:id/actions/enable
http POST {{baseUrl}}/managed_accounts/:id/actions/enable
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/managed_accounts/:id/actions/enable
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/managed_accounts/:id/actions/enable")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"api_key": "KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu",
"api_token": "x6oexQNHTs-fZ7-QsDMOeg",
"api_user": "managed_account@example.com",
"balance": {
"available_credit": "400.00",
"balance": "300.00",
"credit_limit": "100.00",
"currency": "USD",
"record_type": "balance"
},
"created_at": "2018-02-02T22:25:27.521Z",
"email": "user@example.com",
"id": "f65ceda4-6522-4ad6-aede-98de83385123",
"manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
"organization_name": "Example Company LLC",
"record_type": "managed_account",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Lists accounts managed by the current user.
{{baseUrl}}/managed_accounts
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/managed_accounts");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/managed_accounts")
require "http/client"
url = "{{baseUrl}}/managed_accounts"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/managed_accounts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/managed_accounts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/managed_accounts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/managed_accounts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/managed_accounts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/managed_accounts"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/managed_accounts")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/managed_accounts")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/managed_accounts');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/managed_accounts'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/managed_accounts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/managed_accounts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/managed_accounts")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/managed_accounts',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/managed_accounts'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/managed_accounts');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/managed_accounts'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/managed_accounts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/managed_accounts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/managed_accounts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/managed_accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/managed_accounts');
echo $response->getBody();
setUrl('{{baseUrl}}/managed_accounts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/managed_accounts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/managed_accounts' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/managed_accounts' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/managed_accounts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/managed_accounts"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/managed_accounts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/managed_accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/managed_accounts') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/managed_accounts";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/managed_accounts
http GET {{baseUrl}}/managed_accounts
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/managed_accounts
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/managed_accounts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a managed account
{{baseUrl}}/managed_accounts/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/managed_accounts/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/managed_accounts/:id")
require "http/client"
url = "{{baseUrl}}/managed_accounts/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/managed_accounts/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/managed_accounts/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/managed_accounts/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/managed_accounts/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/managed_accounts/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/managed_accounts/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/managed_accounts/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/managed_accounts/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/managed_accounts/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/managed_accounts/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/managed_accounts/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/managed_accounts/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/managed_accounts/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/managed_accounts/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/managed_accounts/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/managed_accounts/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/managed_accounts/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/managed_accounts/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/managed_accounts/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/managed_accounts/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/managed_accounts/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/managed_accounts/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/managed_accounts/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/managed_accounts/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/managed_accounts/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/managed_accounts/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/managed_accounts/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/managed_accounts/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/managed_accounts/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/managed_accounts/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/managed_accounts/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/managed_accounts/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/managed_accounts/:id
http GET {{baseUrl}}/managed_accounts/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/managed_accounts/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/managed_accounts/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"api_key": "KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu",
"api_token": "x6oexQNHTs-fZ7-QsDMOeg",
"api_user": "managed_account@example.com",
"balance": {
"available_credit": "400.00",
"balance": "300.00",
"credit_limit": "100.00",
"currency": "USD",
"record_type": "balance"
},
"created_at": "2018-02-02T22:25:27.521Z",
"email": "user@example.com",
"id": "f65ceda4-6522-4ad6-aede-98de83385123",
"manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
"organization_name": "Example Company LLC",
"record_type": "managed_account",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Fetch all Mdr records
{{baseUrl}}/reports/mdrs
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/mdrs");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/mdrs")
require "http/client"
url = "{{baseUrl}}/reports/mdrs"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/mdrs"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/mdrs");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/mdrs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/mdrs HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/mdrs")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/mdrs"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/mdrs")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/mdrs")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/reports/mdrs');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/reports/mdrs'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/mdrs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/mdrs',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/mdrs")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/mdrs',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/reports/mdrs'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/mdrs');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/reports/mdrs'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/mdrs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/mdrs"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/mdrs" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/mdrs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/reports/mdrs');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/mdrs');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/mdrs');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/mdrs' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/mdrs' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/mdrs")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/mdrs"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/mdrs"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/mdrs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/mdrs') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/mdrs";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/mdrs
http GET {{baseUrl}}/reports/mdrs
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/mdrs
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/mdrs")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
DELETE
deleteMdrRequest
{{baseUrl}}/reports/batch_mdr_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/batch_mdr_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/reports/batch_mdr_reports/:id")
require "http/client"
url = "{{baseUrl}}/reports/batch_mdr_reports/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/reports/batch_mdr_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/batch_mdr_reports/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/batch_mdr_reports/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/reports/batch_mdr_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/reports/batch_mdr_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/batch_mdr_reports/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/batch_mdr_reports/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/reports/batch_mdr_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/reports/batch_mdr_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/reports/batch_mdr_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/batch_mdr_reports/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/batch_mdr_reports/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/batch_mdr_reports/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/batch_mdr_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/reports/batch_mdr_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/reports/batch_mdr_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/reports/batch_mdr_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/batch_mdr_reports/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/batch_mdr_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/batch_mdr_reports/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/batch_mdr_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/reports/batch_mdr_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/batch_mdr_reports/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/batch_mdr_reports/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/batch_mdr_reports/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/batch_mdr_reports/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/reports/batch_mdr_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/batch_mdr_reports/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/batch_mdr_reports/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/batch_mdr_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/reports/batch_mdr_reports/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/batch_mdr_reports/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/reports/batch_mdr_reports/:id
http DELETE {{baseUrl}}/reports/batch_mdr_reports/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/reports/batch_mdr_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/batch_mdr_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_report",
"report_name": "report_name_8hvb45Gu",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"start_date": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00"
}
}
GET
getCdrRequests
{{baseUrl}}/reports/batch_mdr_reports
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/batch_mdr_reports");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/batch_mdr_reports")
require "http/client"
url = "{{baseUrl}}/reports/batch_mdr_reports"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/batch_mdr_reports"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/batch_mdr_reports");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/batch_mdr_reports"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/batch_mdr_reports HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/batch_mdr_reports")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/batch_mdr_reports"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/batch_mdr_reports")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/batch_mdr_reports")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/reports/batch_mdr_reports');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/reports/batch_mdr_reports'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/batch_mdr_reports';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/batch_mdr_reports',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/batch_mdr_reports")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/batch_mdr_reports',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/reports/batch_mdr_reports'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/batch_mdr_reports');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/reports/batch_mdr_reports'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/batch_mdr_reports';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/batch_mdr_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/batch_mdr_reports" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/batch_mdr_reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/reports/batch_mdr_reports');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/batch_mdr_reports');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/batch_mdr_reports');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/batch_mdr_reports' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/batch_mdr_reports' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/batch_mdr_reports")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/batch_mdr_reports"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/batch_mdr_reports"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/batch_mdr_reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/batch_mdr_reports') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/batch_mdr_reports";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/batch_mdr_reports
http GET {{baseUrl}}/reports/batch_mdr_reports
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/batch_mdr_reports
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/batch_mdr_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
getMdrRequest
{{baseUrl}}/reports/batch_mdr_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/batch_mdr_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/batch_mdr_reports/:id")
require "http/client"
url = "{{baseUrl}}/reports/batch_mdr_reports/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/batch_mdr_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/batch_mdr_reports/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/batch_mdr_reports/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/batch_mdr_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/batch_mdr_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/batch_mdr_reports/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/batch_mdr_reports/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/batch_mdr_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/reports/batch_mdr_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/batch_mdr_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/batch_mdr_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/batch_mdr_reports/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/batch_mdr_reports/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/batch_mdr_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/batch_mdr_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/batch_mdr_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/batch_mdr_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/batch_mdr_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/batch_mdr_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/batch_mdr_reports/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/batch_mdr_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/reports/batch_mdr_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/batch_mdr_reports/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/batch_mdr_reports/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/batch_mdr_reports/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/batch_mdr_reports/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/batch_mdr_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/batch_mdr_reports/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/batch_mdr_reports/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/batch_mdr_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/batch_mdr_reports/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/batch_mdr_reports/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/batch_mdr_reports/:id
http GET {{baseUrl}}/reports/batch_mdr_reports/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/batch_mdr_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/batch_mdr_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_report",
"report_name": "report_name_8hvb45Gu",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"start_date": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00"
}
}
POST
submitMdrRequest
{{baseUrl}}/reports/batch_mdr_reports
BODY json
{
"connections": [],
"directions": [],
"end_date": "",
"filters": [
{
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
}
],
"include_message_body": false,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/batch_mdr_reports");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/reports/batch_mdr_reports" {:content-type :json
:form-params {:connections []
:directions []
:end_date ""
:filters [{:billing_group ""
:cld ""
:cld_filter ""
:cli ""
:cli_filter ""
:filter_type ""
:tags_list ""}]
:include_message_body false
:profiles ""
:record_types []
:report_name ""
:start_date ""}})
require "http/client"
url = "{{baseUrl}}/reports/batch_mdr_reports"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/reports/batch_mdr_reports"),
Content = new StringContent("{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/batch_mdr_reports");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/batch_mdr_reports"
payload := strings.NewReader("{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/reports/batch_mdr_reports HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 363
{
"connections": [],
"directions": [],
"end_date": "",
"filters": [
{
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
}
],
"include_message_body": false,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/reports/batch_mdr_reports")
.setHeader("content-type", "application/json")
.setBody("{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/batch_mdr_reports"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/batch_mdr_reports")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/reports/batch_mdr_reports")
.header("content-type", "application/json")
.body("{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}")
.asString();
const data = JSON.stringify({
connections: [],
directions: [],
end_date: '',
filters: [
{
billing_group: '',
cld: '',
cld_filter: '',
cli: '',
cli_filter: '',
filter_type: '',
tags_list: ''
}
],
include_message_body: false,
profiles: '',
record_types: [],
report_name: '',
start_date: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/reports/batch_mdr_reports');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/reports/batch_mdr_reports',
headers: {'content-type': 'application/json'},
data: {
connections: [],
directions: [],
end_date: '',
filters: [
{
billing_group: '',
cld: '',
cld_filter: '',
cli: '',
cli_filter: '',
filter_type: '',
tags_list: ''
}
],
include_message_body: false,
profiles: '',
record_types: [],
report_name: '',
start_date: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/batch_mdr_reports';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connections":[],"directions":[],"end_date":"","filters":[{"billing_group":"","cld":"","cld_filter":"","cli":"","cli_filter":"","filter_type":"","tags_list":""}],"include_message_body":false,"profiles":"","record_types":[],"report_name":"","start_date":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/batch_mdr_reports',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "connections": [],\n "directions": [],\n "end_date": "",\n "filters": [\n {\n "billing_group": "",\n "cld": "",\n "cld_filter": "",\n "cli": "",\n "cli_filter": "",\n "filter_type": "",\n "tags_list": ""\n }\n ],\n "include_message_body": false,\n "profiles": "",\n "record_types": [],\n "report_name": "",\n "start_date": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/reports/batch_mdr_reports")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/batch_mdr_reports',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
connections: [],
directions: [],
end_date: '',
filters: [
{
billing_group: '',
cld: '',
cld_filter: '',
cli: '',
cli_filter: '',
filter_type: '',
tags_list: ''
}
],
include_message_body: false,
profiles: '',
record_types: [],
report_name: '',
start_date: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/reports/batch_mdr_reports',
headers: {'content-type': 'application/json'},
body: {
connections: [],
directions: [],
end_date: '',
filters: [
{
billing_group: '',
cld: '',
cld_filter: '',
cli: '',
cli_filter: '',
filter_type: '',
tags_list: ''
}
],
include_message_body: false,
profiles: '',
record_types: [],
report_name: '',
start_date: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/reports/batch_mdr_reports');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
connections: [],
directions: [],
end_date: '',
filters: [
{
billing_group: '',
cld: '',
cld_filter: '',
cli: '',
cli_filter: '',
filter_type: '',
tags_list: ''
}
],
include_message_body: false,
profiles: '',
record_types: [],
report_name: '',
start_date: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/reports/batch_mdr_reports',
headers: {'content-type': 'application/json'},
data: {
connections: [],
directions: [],
end_date: '',
filters: [
{
billing_group: '',
cld: '',
cld_filter: '',
cli: '',
cli_filter: '',
filter_type: '',
tags_list: ''
}
],
include_message_body: false,
profiles: '',
record_types: [],
report_name: '',
start_date: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/batch_mdr_reports';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connections":[],"directions":[],"end_date":"","filters":[{"billing_group":"","cld":"","cld_filter":"","cli":"","cli_filter":"","filter_type":"","tags_list":""}],"include_message_body":false,"profiles":"","record_types":[],"report_name":"","start_date":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"connections": @[ ],
@"directions": @[ ],
@"end_date": @"",
@"filters": @[ @{ @"billing_group": @"", @"cld": @"", @"cld_filter": @"", @"cli": @"", @"cli_filter": @"", @"filter_type": @"", @"tags_list": @"" } ],
@"include_message_body": @NO,
@"profiles": @"",
@"record_types": @[ ],
@"report_name": @"",
@"start_date": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/batch_mdr_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/batch_mdr_reports" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/batch_mdr_reports",
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([
'connections' => [
],
'directions' => [
],
'end_date' => '',
'filters' => [
[
'billing_group' => '',
'cld' => '',
'cld_filter' => '',
'cli' => '',
'cli_filter' => '',
'filter_type' => '',
'tags_list' => ''
]
],
'include_message_body' => null,
'profiles' => '',
'record_types' => [
],
'report_name' => '',
'start_date' => ''
]),
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;
}
request('POST', '{{baseUrl}}/reports/batch_mdr_reports', [
'body' => '{
"connections": [],
"directions": [],
"end_date": "",
"filters": [
{
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
}
],
"include_message_body": false,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/reports/batch_mdr_reports');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'connections' => [
],
'directions' => [
],
'end_date' => '',
'filters' => [
[
'billing_group' => '',
'cld' => '',
'cld_filter' => '',
'cli' => '',
'cli_filter' => '',
'filter_type' => '',
'tags_list' => ''
]
],
'include_message_body' => null,
'profiles' => '',
'record_types' => [
],
'report_name' => '',
'start_date' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'connections' => [
],
'directions' => [
],
'end_date' => '',
'filters' => [
[
'billing_group' => '',
'cld' => '',
'cld_filter' => '',
'cli' => '',
'cli_filter' => '',
'filter_type' => '',
'tags_list' => ''
]
],
'include_message_body' => null,
'profiles' => '',
'record_types' => [
],
'report_name' => '',
'start_date' => ''
]));
$request->setRequestUrl('{{baseUrl}}/reports/batch_mdr_reports');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/batch_mdr_reports' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connections": [],
"directions": [],
"end_date": "",
"filters": [
{
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
}
],
"include_message_body": false,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/batch_mdr_reports' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connections": [],
"directions": [],
"end_date": "",
"filters": [
{
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
}
],
"include_message_body": false,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/reports/batch_mdr_reports", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/batch_mdr_reports"
payload = {
"connections": [],
"directions": [],
"end_date": "",
"filters": [
{
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
}
],
"include_message_body": False,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/batch_mdr_reports"
payload <- "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/batch_mdr_reports")
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 \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/reports/batch_mdr_reports') do |req|
req.body = "{\n \"connections\": [],\n \"directions\": [],\n \"end_date\": \"\",\n \"filters\": [\n {\n \"billing_group\": \"\",\n \"cld\": \"\",\n \"cld_filter\": \"\",\n \"cli\": \"\",\n \"cli_filter\": \"\",\n \"filter_type\": \"\",\n \"tags_list\": \"\"\n }\n ],\n \"include_message_body\": false,\n \"profiles\": \"\",\n \"record_types\": [],\n \"report_name\": \"\",\n \"start_date\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/batch_mdr_reports";
let payload = json!({
"connections": (),
"directions": (),
"end_date": "",
"filters": (
json!({
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
})
),
"include_message_body": false,
"profiles": "",
"record_types": (),
"report_name": "",
"start_date": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/reports/batch_mdr_reports \
--header 'content-type: application/json' \
--data '{
"connections": [],
"directions": [],
"end_date": "",
"filters": [
{
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
}
],
"include_message_body": false,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
}'
echo '{
"connections": [],
"directions": [],
"end_date": "",
"filters": [
{
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
}
],
"include_message_body": false,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
}' | \
http POST {{baseUrl}}/reports/batch_mdr_reports \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "connections": [],\n "directions": [],\n "end_date": "",\n "filters": [\n {\n "billing_group": "",\n "cld": "",\n "cld_filter": "",\n "cli": "",\n "cli_filter": "",\n "filter_type": "",\n "tags_list": ""\n }\n ],\n "include_message_body": false,\n "profiles": "",\n "record_types": [],\n "report_name": "",\n "start_date": ""\n}' \
--output-document \
- {{baseUrl}}/reports/batch_mdr_reports
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"connections": [],
"directions": [],
"end_date": "",
"filters": [
[
"billing_group": "",
"cld": "",
"cld_filter": "",
"cli": "",
"cli_filter": "",
"filter_type": "",
"tags_list": ""
]
],
"include_message_body": false,
"profiles": "",
"record_types": [],
"report_name": "",
"start_date": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/batch_mdr_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_report",
"report_name": "report_name_8hvb45Gu",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"start_date": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00"
}
}
GET
Fetch message body by id.
{{baseUrl}}/message_detail_records/:id/message_body
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/message_detail_records/:id/message_body");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/message_detail_records/:id/message_body")
require "http/client"
url = "{{baseUrl}}/message_detail_records/:id/message_body"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/message_detail_records/:id/message_body"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/message_detail_records/:id/message_body");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/message_detail_records/:id/message_body"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/message_detail_records/:id/message_body HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/message_detail_records/:id/message_body")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/message_detail_records/:id/message_body"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/message_detail_records/:id/message_body")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/message_detail_records/:id/message_body")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/message_detail_records/:id/message_body');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/message_detail_records/:id/message_body'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/message_detail_records/:id/message_body';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/message_detail_records/:id/message_body',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/message_detail_records/:id/message_body")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/message_detail_records/:id/message_body',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/message_detail_records/:id/message_body'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/message_detail_records/:id/message_body');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/message_detail_records/:id/message_body'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/message_detail_records/:id/message_body';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/message_detail_records/:id/message_body"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/message_detail_records/:id/message_body" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/message_detail_records/:id/message_body",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/message_detail_records/:id/message_body');
echo $response->getBody();
setUrl('{{baseUrl}}/message_detail_records/:id/message_body');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/message_detail_records/:id/message_body');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/message_detail_records/:id/message_body' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/message_detail_records/:id/message_body' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/message_detail_records/:id/message_body")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/message_detail_records/:id/message_body"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/message_detail_records/:id/message_body"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/message_detail_records/:id/message_body")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/message_detail_records/:id/message_body') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/message_detail_records/:id/message_body";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/message_detail_records/:id/message_body
http GET {{baseUrl}}/message_detail_records/:id/message_body
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/message_detail_records/:id/message_body
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/message_detail_records/:id/message_body")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"message_body": "This is message text",
"record_type": "message_body"
}
}
GET
Fetch messaging detail records.
{{baseUrl}}/message_detail_records
QUERY PARAMS
start_date
end_date
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/message_detail_records?start_date=&end_date=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/message_detail_records" {:query-params {:start_date ""
:end_date ""}})
require "http/client"
url = "{{baseUrl}}/message_detail_records?start_date=&end_date="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/message_detail_records?start_date=&end_date="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/message_detail_records?start_date=&end_date=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/message_detail_records?start_date=&end_date="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/message_detail_records?start_date=&end_date= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/message_detail_records?start_date=&end_date=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/message_detail_records?start_date=&end_date="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/message_detail_records?start_date=&end_date=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/message_detail_records?start_date=&end_date=")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/message_detail_records?start_date=&end_date=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/message_detail_records',
params: {start_date: '', end_date: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/message_detail_records?start_date=&end_date=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/message_detail_records?start_date=&end_date=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/message_detail_records?start_date=&end_date=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/message_detail_records?start_date=&end_date=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/message_detail_records',
qs: {start_date: '', end_date: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/message_detail_records');
req.query({
start_date: '',
end_date: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/message_detail_records',
params: {start_date: '', end_date: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/message_detail_records?start_date=&end_date=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/message_detail_records?start_date=&end_date="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/message_detail_records?start_date=&end_date=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/message_detail_records?start_date=&end_date=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/message_detail_records?start_date=&end_date=');
echo $response->getBody();
setUrl('{{baseUrl}}/message_detail_records');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'start_date' => '',
'end_date' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/message_detail_records');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'start_date' => '',
'end_date' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/message_detail_records?start_date=&end_date=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/message_detail_records?start_date=&end_date=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/message_detail_records?start_date=&end_date=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/message_detail_records"
querystring = {"start_date":"","end_date":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/message_detail_records"
queryString <- list(
start_date = "",
end_date = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/message_detail_records?start_date=&end_date=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/message_detail_records') do |req|
req.params['start_date'] = ''
req.params['end_date'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/message_detail_records";
let querystring = [
("start_date", ""),
("end_date", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/message_detail_records?start_date=&end_date='
http GET '{{baseUrl}}/message_detail_records?start_date=&end_date='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/message_detail_records?start_date=&end_date='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/message_detail_records?start_date=&end_date=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
DELETE
deleteUsageReport
{{baseUrl}}/reports/mdr_usage_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/mdr_usage_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/reports/mdr_usage_reports/:id")
require "http/client"
url = "{{baseUrl}}/reports/mdr_usage_reports/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/reports/mdr_usage_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/mdr_usage_reports/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/mdr_usage_reports/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/reports/mdr_usage_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/reports/mdr_usage_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/mdr_usage_reports/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/reports/mdr_usage_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/reports/mdr_usage_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/reports/mdr_usage_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/mdr_usage_reports/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/mdr_usage_reports/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/mdr_usage_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/reports/mdr_usage_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/reports/mdr_usage_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/reports/mdr_usage_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/mdr_usage_reports/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/mdr_usage_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/mdr_usage_reports/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/mdr_usage_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/reports/mdr_usage_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/mdr_usage_reports/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/mdr_usage_reports/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/mdr_usage_reports/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/mdr_usage_reports/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/reports/mdr_usage_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/mdr_usage_reports/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/mdr_usage_reports/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/mdr_usage_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/reports/mdr_usage_reports/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/mdr_usage_reports/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/reports/mdr_usage_reports/:id
http DELETE {{baseUrl}}/reports/mdr_usage_reports/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/reports/mdr_usage_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/mdr_usage_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_usage_report",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"start_date": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00"
}
}
GET
getUsageReport
{{baseUrl}}/reports/mdr_usage_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/mdr_usage_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/mdr_usage_reports/:id")
require "http/client"
url = "{{baseUrl}}/reports/mdr_usage_reports/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/mdr_usage_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/mdr_usage_reports/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/mdr_usage_reports/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/mdr_usage_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/mdr_usage_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/mdr_usage_reports/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/mdr_usage_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/reports/mdr_usage_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/mdr_usage_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/mdr_usage_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/mdr_usage_reports/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/mdr_usage_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/mdr_usage_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/mdr_usage_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/mdr_usage_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/mdr_usage_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/mdr_usage_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/mdr_usage_reports/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/mdr_usage_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/reports/mdr_usage_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/mdr_usage_reports/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/mdr_usage_reports/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/mdr_usage_reports/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/mdr_usage_reports/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/mdr_usage_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/mdr_usage_reports/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/mdr_usage_reports/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/mdr_usage_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/mdr_usage_reports/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/mdr_usage_reports/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/mdr_usage_reports/:id
http GET {{baseUrl}}/reports/mdr_usage_reports/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/mdr_usage_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/mdr_usage_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_usage_report",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"start_date": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00"
}
}
GET
getUsageReportSync_1
{{baseUrl}}/reports/mdr_usage_reports/sync
QUERY PARAMS
aggregation_type
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/mdr_usage_reports/sync" {:query-params {:aggregation_type ""}})
require "http/client"
url = "{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/mdr_usage_reports/sync?aggregation_type= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/mdr_usage_reports/sync',
params: {aggregation_type: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/mdr_usage_reports/sync?aggregation_type=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/mdr_usage_reports/sync',
qs: {aggregation_type: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/mdr_usage_reports/sync');
req.query({
aggregation_type: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/reports/mdr_usage_reports/sync',
params: {aggregation_type: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/mdr_usage_reports/sync');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'aggregation_type' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/mdr_usage_reports/sync');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'aggregation_type' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/mdr_usage_reports/sync?aggregation_type=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/mdr_usage_reports/sync"
querystring = {"aggregation_type":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/mdr_usage_reports/sync"
queryString <- list(aggregation_type = "")
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/mdr_usage_reports/sync') do |req|
req.params['aggregation_type'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/mdr_usage_reports/sync";
let querystring = [
("aggregation_type", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type='
http GET '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/mdr_usage_reports/sync?aggregation_type=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_usage_report",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"start_date": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00"
}
}
GET
getUsageReports
{{baseUrl}}/reports/mdr_usage_reports
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/mdr_usage_reports");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/mdr_usage_reports")
require "http/client"
url = "{{baseUrl}}/reports/mdr_usage_reports"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/mdr_usage_reports"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/mdr_usage_reports");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/mdr_usage_reports"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/mdr_usage_reports HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/mdr_usage_reports")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/mdr_usage_reports"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/mdr_usage_reports")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/reports/mdr_usage_reports');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/reports/mdr_usage_reports'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/mdr_usage_reports';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/mdr_usage_reports',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/mdr_usage_reports',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/reports/mdr_usage_reports'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/mdr_usage_reports');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/reports/mdr_usage_reports'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/mdr_usage_reports';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/mdr_usage_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/mdr_usage_reports" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/mdr_usage_reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/reports/mdr_usage_reports');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/mdr_usage_reports');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/mdr_usage_reports');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/mdr_usage_reports' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/mdr_usage_reports' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/mdr_usage_reports")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/mdr_usage_reports"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/mdr_usage_reports"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/mdr_usage_reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/mdr_usage_reports') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/mdr_usage_reports";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/mdr_usage_reports
http GET {{baseUrl}}/reports/mdr_usage_reports
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/mdr_usage_reports
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/mdr_usage_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
submitUsageReport
{{baseUrl}}/reports/mdr_usage_reports
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/mdr_usage_reports");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/reports/mdr_usage_reports")
require "http/client"
url = "{{baseUrl}}/reports/mdr_usage_reports"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/reports/mdr_usage_reports"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/mdr_usage_reports");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/mdr_usage_reports"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/reports/mdr_usage_reports HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/reports/mdr_usage_reports")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/mdr_usage_reports"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/reports/mdr_usage_reports")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/reports/mdr_usage_reports');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/reports/mdr_usage_reports'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/mdr_usage_reports';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/mdr_usage_reports',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/mdr_usage_reports")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/mdr_usage_reports',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/reports/mdr_usage_reports'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/reports/mdr_usage_reports');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/reports/mdr_usage_reports'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/mdr_usage_reports';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/mdr_usage_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/mdr_usage_reports" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/mdr_usage_reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/reports/mdr_usage_reports');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/mdr_usage_reports');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/mdr_usage_reports');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/mdr_usage_reports' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/mdr_usage_reports' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/reports/mdr_usage_reports")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/mdr_usage_reports"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/mdr_usage_reports"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/mdr_usage_reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/reports/mdr_usage_reports') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/mdr_usage_reports";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/reports/mdr_usage_reports
http POST {{baseUrl}}/reports/mdr_usage_reports
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/reports/mdr_usage_reports
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/mdr_usage_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-07-01T00:00:00-06:00",
"end_date": "2020-07-01T00:00:00-06:00",
"profiles": "My profile",
"record_type": "mdr_usage_report",
"report_url": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv",
"start_date": "2020-07-01T00:00:00-06:00",
"updated_at": "2020-07-01T00:00:00-06:00"
}
}
DELETE
Deletes stored media
{{baseUrl}}/media/:media_name
QUERY PARAMS
media_name
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/media/:media_name");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/media/:media_name")
require "http/client"
url = "{{baseUrl}}/media/:media_name"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/media/:media_name"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/media/:media_name");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/media/:media_name"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/media/:media_name HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/media/:media_name")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/media/:media_name"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/media/:media_name")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/media/:media_name")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/media/:media_name');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/media/:media_name'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/media/:media_name';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/media/:media_name',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/media/:media_name")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/media/:media_name',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/media/:media_name'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/media/:media_name');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/media/:media_name'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/media/:media_name';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/media/:media_name"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/media/:media_name" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/media/:media_name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/media/:media_name');
echo $response->getBody();
setUrl('{{baseUrl}}/media/:media_name');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/media/:media_name');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/media/:media_name' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/media/:media_name' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/media/:media_name")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/media/:media_name"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/media/:media_name"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/media/:media_name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/media/:media_name') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/media/:media_name";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/media/:media_name
http DELETE {{baseUrl}}/media/:media_name
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/media/:media_name
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/media/:media_name")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download stored media
{{baseUrl}}/media/:media_name/download
QUERY PARAMS
media_name
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/media/:media_name/download");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/media/:media_name/download")
require "http/client"
url = "{{baseUrl}}/media/:media_name/download"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/media/:media_name/download"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/media/:media_name/download");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/media/:media_name/download"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/media/:media_name/download HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/media/:media_name/download")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/media/:media_name/download"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/media/:media_name/download")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/media/:media_name/download")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/media/:media_name/download');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/media/:media_name/download'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/media/:media_name/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/media/:media_name/download',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/media/:media_name/download")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/media/:media_name/download',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/media/:media_name/download'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/media/:media_name/download');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/media/:media_name/download'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/media/:media_name/download';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/media/:media_name/download"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/media/:media_name/download" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/media/:media_name/download",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/media/:media_name/download');
echo $response->getBody();
setUrl('{{baseUrl}}/media/:media_name/download');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/media/:media_name/download');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/media/:media_name/download' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/media/:media_name/download' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/media/:media_name/download")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/media/:media_name/download"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/media/:media_name/download"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/media/:media_name/download")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/media/:media_name/download') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/media/:media_name/download";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/media/:media_name/download
http GET {{baseUrl}}/media/:media_name/download
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/media/:media_name/download
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/media/:media_name/download")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List uploaded media
{{baseUrl}}/media
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/media");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/media")
require "http/client"
url = "{{baseUrl}}/media"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/media"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/media");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/media"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/media HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/media")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/media"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/media")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/media")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/media');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/media'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/media';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/media',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/media")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/media',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/media'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/media');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/media'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/media';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/media"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/media" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/media",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/media');
echo $response->getBody();
setUrl('{{baseUrl}}/media');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/media');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/media' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/media' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/media")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/media"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/media"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/media")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/media') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/media";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/media
http GET {{baseUrl}}/media
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/media
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/media")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"created_at": "2019-01-23T18:10:02.574Z",
"expires_at": "2020-01-23T18:10:02.574Z",
"media_name": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"updated_at": "2019-01-23T18:10:02.574Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve stored media
{{baseUrl}}/media/:media_name
QUERY PARAMS
media_name
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/media/:media_name");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/media/:media_name")
require "http/client"
url = "{{baseUrl}}/media/:media_name"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/media/:media_name"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/media/:media_name");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/media/:media_name"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/media/:media_name HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/media/:media_name")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/media/:media_name"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/media/:media_name")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/media/:media_name")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/media/:media_name');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/media/:media_name'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/media/:media_name';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/media/:media_name',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/media/:media_name")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/media/:media_name',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/media/:media_name'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/media/:media_name');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/media/:media_name'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/media/:media_name';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/media/:media_name"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/media/:media_name" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/media/:media_name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/media/:media_name');
echo $response->getBody();
setUrl('{{baseUrl}}/media/:media_name');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/media/:media_name');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/media/:media_name' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/media/:media_name' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/media/:media_name")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/media/:media_name"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/media/:media_name"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/media/:media_name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/media/:media_name') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/media/:media_name";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/media/:media_name
http GET {{baseUrl}}/media/:media_name
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/media/:media_name
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/media/:media_name")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-01-23T18:10:02.574Z",
"expires_at": "2020-01-23T18:10:02.574Z",
"media_name": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
PUT
Update stored media
{{baseUrl}}/media/:media_name
QUERY PARAMS
media_name
BODY json
{
"media_url": "",
"ttl_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/media/:media_name");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/media/:media_name" {:content-type :json
:form-params {:media_url ""
:ttl_secs 0}})
require "http/client"
url = "{{baseUrl}}/media/:media_name"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/media/:media_name"),
Content = new StringContent("{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/media/:media_name");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/media/:media_name"
payload := strings.NewReader("{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
req, _ := http.NewRequest("PUT", 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(res)
fmt.Println(string(body))
}
PUT /baseUrl/media/:media_name HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 38
{
"media_url": "",
"ttl_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/media/:media_name")
.setHeader("content-type", "application/json")
.setBody("{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/media/:media_name"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/media/:media_name")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/media/:media_name")
.header("content-type", "application/json")
.body("{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
.asString();
const data = JSON.stringify({
media_url: '',
ttl_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/media/:media_name');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/media/:media_name',
headers: {'content-type': 'application/json'},
data: {media_url: '', ttl_secs: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/media/:media_name';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"media_url":"","ttl_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/media/:media_name',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "media_url": "",\n "ttl_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/media/:media_name")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/media/:media_name',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({media_url: '', ttl_secs: 0}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/media/:media_name',
headers: {'content-type': 'application/json'},
body: {media_url: '', ttl_secs: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/media/:media_name');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
media_url: '',
ttl_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/media/:media_name',
headers: {'content-type': 'application/json'},
data: {media_url: '', ttl_secs: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/media/:media_name';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"media_url":"","ttl_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"media_url": @"",
@"ttl_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/media/:media_name"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/media/:media_name" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/media/:media_name",
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([
'media_url' => '',
'ttl_secs' => 0
]),
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;
}
request('PUT', '{{baseUrl}}/media/:media_name', [
'body' => '{
"media_url": "",
"ttl_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/media/:media_name');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'media_url' => '',
'ttl_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'media_url' => '',
'ttl_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/media/:media_name');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/media/:media_name' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"media_url": "",
"ttl_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/media/:media_name' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"media_url": "",
"ttl_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/media/:media_name", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/media/:media_name"
payload = {
"media_url": "",
"ttl_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/media/:media_name"
payload <- "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/media/:media_name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/media/:media_name') do |req|
req.body = "{\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/media/:media_name";
let payload = json!({
"media_url": "",
"ttl_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/media/:media_name \
--header 'content-type: application/json' \
--data '{
"media_url": "",
"ttl_secs": 0
}'
echo '{
"media_url": "",
"ttl_secs": 0
}' | \
http PUT {{baseUrl}}/media/:media_name \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "media_url": "",\n "ttl_secs": 0\n}' \
--output-document \
- {{baseUrl}}/media/:media_name
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"media_url": "",
"ttl_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/media/:media_name")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-01-23T18:10:02.574Z",
"expires_at": "2020-01-23T18:10:02.574Z",
"media_name": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
POST
Upload media
{{baseUrl}}/media
BODY json
{
"media_name": "",
"media_url": "",
"ttl_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/media");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/media" {:content-type :json
:form-params {:media_name ""
:media_url ""
:ttl_secs 0}})
require "http/client"
url = "{{baseUrl}}/media"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/media"),
Content = new StringContent("{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/media");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/media"
payload := strings.NewReader("{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/media HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 58
{
"media_name": "",
"media_url": "",
"ttl_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/media")
.setHeader("content-type", "application/json")
.setBody("{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/media"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/media")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/media")
.header("content-type", "application/json")
.body("{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
.asString();
const data = JSON.stringify({
media_name: '',
media_url: '',
ttl_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/media');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/media',
headers: {'content-type': 'application/json'},
data: {media_name: '', media_url: '', ttl_secs: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/media';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"media_name":"","media_url":"","ttl_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/media',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "media_name": "",\n "media_url": "",\n "ttl_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/media")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/media',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({media_name: '', media_url: '', ttl_secs: 0}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/media',
headers: {'content-type': 'application/json'},
body: {media_name: '', media_url: '', ttl_secs: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/media');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
media_name: '',
media_url: '',
ttl_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/media',
headers: {'content-type': 'application/json'},
data: {media_name: '', media_url: '', ttl_secs: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/media';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"media_name":"","media_url":"","ttl_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"media_name": @"",
@"media_url": @"",
@"ttl_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/media"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/media" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/media",
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([
'media_name' => '',
'media_url' => '',
'ttl_secs' => 0
]),
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;
}
request('POST', '{{baseUrl}}/media', [
'body' => '{
"media_name": "",
"media_url": "",
"ttl_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/media');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'media_name' => '',
'media_url' => '',
'ttl_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'media_name' => '',
'media_url' => '',
'ttl_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/media');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/media' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"media_name": "",
"media_url": "",
"ttl_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/media' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"media_name": "",
"media_url": "",
"ttl_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/media", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/media"
payload = {
"media_name": "",
"media_url": "",
"ttl_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/media"
payload <- "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/media")
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 \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/media') do |req|
req.body = "{\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"ttl_secs\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/media";
let payload = json!({
"media_name": "",
"media_url": "",
"ttl_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/media \
--header 'content-type: application/json' \
--data '{
"media_name": "",
"media_url": "",
"ttl_secs": 0
}'
echo '{
"media_name": "",
"media_url": "",
"ttl_secs": 0
}' | \
http POST {{baseUrl}}/media \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "media_name": "",\n "media_url": "",\n "ttl_secs": 0\n}' \
--output-document \
- {{baseUrl}}/media
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"media_name": "",
"media_url": "",
"ttl_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/media")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-01-23T18:10:02.574Z",
"expires_at": "2020-01-23T18:10:02.574Z",
"media_name": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
GET
Retrieve a message
{{baseUrl}}/messages/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messages/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messages/:id")
require "http/client"
url = "{{baseUrl}}/messages/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messages/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messages/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messages/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messages/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messages/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messages/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messages/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messages/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messages/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/messages/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messages/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messages/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messages/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messages/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/messages/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messages/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/messages/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messages/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messages/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messages/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messages/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messages/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/messages/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messages/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messages/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messages/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messages/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messages/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messages/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messages/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messages/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messages/:id
http GET {{baseUrl}}/messages/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messages/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messages/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"completed_at": null,
"cost": null,
"direction": "outbound",
"encoding": "GSM-7",
"errors": [],
"from": {
"carrier": "TELNYX LLC",
"line_type": "VoIP",
"phone_number": "+18445550001"
},
"id": "40385f64-5717-4562-b3fc-2c963f66afa6",
"media": [
{
"content_type": null,
"sha256": null,
"size": null,
"url": "https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png"
}
],
"messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
"organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
"parts": 1,
"received_at": "2019-01-23T18:10:02.574Z",
"record_type": "message",
"sent_at": null,
"subject": "From Telnyx!",
"tags": [
"Greetings"
],
"text": "Hello, World!",
"to": [
{
"carrier": "T-MOBILE USA, INC.",
"line_type": "Wireless",
"phone_number": "+18665550001",
"status": "queued"
}
],
"type": "MMS",
"valid_until": null,
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks"
}
}
POST
Send a long code message
{{baseUrl}}/messages/long_code
BODY json
{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messages/long_code");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/messages/long_code" {:content-type :json
:form-params {:auto_detect false
:from ""
:media_urls []
:subject ""
:text ""
:to ""
:type ""
:use_profile_webhooks false
:webhook_failover_url ""
:webhook_url ""}})
require "http/client"
url = "{{baseUrl}}/messages/long_code"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/messages/long_code"),
Content = new StringContent("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messages/long_code");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messages/long_code"
payload := strings.NewReader("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/messages/long_code HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 201
{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/messages/long_code")
.setHeader("content-type", "application/json")
.setBody("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messages/long_code"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/messages/long_code")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/messages/long_code")
.header("content-type", "application/json")
.body("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.asString();
const data = JSON.stringify({
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/messages/long_code');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/long_code',
headers: {'content-type': 'application/json'},
data: {
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messages/long_code';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"auto_detect":false,"from":"","media_urls":[],"subject":"","text":"","to":"","type":"","use_profile_webhooks":false,"webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messages/long_code',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "auto_detect": false,\n "from": "",\n "media_urls": [],\n "subject": "",\n "text": "",\n "to": "",\n "type": "",\n "use_profile_webhooks": false,\n "webhook_failover_url": "",\n "webhook_url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/messages/long_code")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/messages/long_code',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/long_code',
headers: {'content-type': 'application/json'},
body: {
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/messages/long_code');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/long_code',
headers: {'content-type': 'application/json'},
data: {
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messages/long_code';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"auto_detect":false,"from":"","media_urls":[],"subject":"","text":"","to":"","type":"","use_profile_webhooks":false,"webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"auto_detect": @NO,
@"from": @"",
@"media_urls": @[ ],
@"subject": @"",
@"text": @"",
@"to": @"",
@"type": @"",
@"use_profile_webhooks": @NO,
@"webhook_failover_url": @"",
@"webhook_url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messages/long_code"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messages/long_code" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messages/long_code",
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([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]),
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;
}
request('POST', '{{baseUrl}}/messages/long_code', [
'body' => '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/messages/long_code');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/messages/long_code');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messages/long_code' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messages/long_code' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/messages/long_code", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messages/long_code"
payload = {
"auto_detect": False,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": False,
"webhook_failover_url": "",
"webhook_url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messages/long_code"
payload <- "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messages/long_code")
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 \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/messages/long_code') do |req|
req.body = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages/long_code";
let payload = json!({
"auto_detect": false,
"from": "",
"media_urls": (),
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/messages/long_code \
--header 'content-type: application/json' \
--data '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
echo '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}' | \
http POST {{baseUrl}}/messages/long_code \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "auto_detect": false,\n "from": "",\n "media_urls": [],\n "subject": "",\n "text": "",\n "to": "",\n "type": "",\n "use_profile_webhooks": false,\n "webhook_failover_url": "",\n "webhook_url": ""\n}' \
--output-document \
- {{baseUrl}}/messages/long_code
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messages/long_code")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"completed_at": null,
"cost": null,
"direction": "outbound",
"encoding": "GSM-7",
"errors": [],
"from": {
"carrier": "TELNYX LLC",
"line_type": "VoIP",
"phone_number": "+18445550001"
},
"id": "40385f64-5717-4562-b3fc-2c963f66afa6",
"media": [
{
"content_type": null,
"sha256": null,
"size": null,
"url": "https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png"
}
],
"messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
"organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
"parts": 1,
"received_at": "2019-01-23T18:10:02.574Z",
"record_type": "message",
"sent_at": null,
"subject": "From Telnyx!",
"tags": [
"Greetings"
],
"text": "Hello, World!",
"to": [
{
"carrier": "T-MOBILE USA, INC.",
"line_type": "Wireless",
"phone_number": "+18665550001",
"status": "queued"
}
],
"type": "MMS",
"valid_until": null,
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks"
}
}
POST
Send a message using number pool
{{baseUrl}}/messages/number_pool
BODY json
{
"auto_detect": false,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messages/number_pool");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/messages/number_pool" {:content-type :json
:form-params {:auto_detect false
:media_urls []
:messaging_profile_id ""
:subject ""
:text ""
:to ""
:type ""
:use_profile_webhooks false
:webhook_failover_url ""
:webhook_url ""}})
require "http/client"
url = "{{baseUrl}}/messages/number_pool"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/messages/number_pool"),
Content = new StringContent("{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messages/number_pool");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messages/number_pool"
payload := strings.NewReader("{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/messages/number_pool HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 217
{
"auto_detect": false,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/messages/number_pool")
.setHeader("content-type", "application/json")
.setBody("{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messages/number_pool"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/messages/number_pool")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/messages/number_pool")
.header("content-type", "application/json")
.body("{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.asString();
const data = JSON.stringify({
auto_detect: false,
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/messages/number_pool');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/number_pool',
headers: {'content-type': 'application/json'},
data: {
auto_detect: false,
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messages/number_pool';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"auto_detect":false,"media_urls":[],"messaging_profile_id":"","subject":"","text":"","to":"","type":"","use_profile_webhooks":false,"webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messages/number_pool',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "auto_detect": false,\n "media_urls": [],\n "messaging_profile_id": "",\n "subject": "",\n "text": "",\n "to": "",\n "type": "",\n "use_profile_webhooks": false,\n "webhook_failover_url": "",\n "webhook_url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/messages/number_pool")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/messages/number_pool',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
auto_detect: false,
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/number_pool',
headers: {'content-type': 'application/json'},
body: {
auto_detect: false,
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/messages/number_pool');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
auto_detect: false,
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/number_pool',
headers: {'content-type': 'application/json'},
data: {
auto_detect: false,
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messages/number_pool';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"auto_detect":false,"media_urls":[],"messaging_profile_id":"","subject":"","text":"","to":"","type":"","use_profile_webhooks":false,"webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"auto_detect": @NO,
@"media_urls": @[ ],
@"messaging_profile_id": @"",
@"subject": @"",
@"text": @"",
@"to": @"",
@"type": @"",
@"use_profile_webhooks": @NO,
@"webhook_failover_url": @"",
@"webhook_url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messages/number_pool"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messages/number_pool" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messages/number_pool",
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([
'auto_detect' => null,
'media_urls' => [
],
'messaging_profile_id' => '',
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]),
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;
}
request('POST', '{{baseUrl}}/messages/number_pool', [
'body' => '{
"auto_detect": false,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/messages/number_pool');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'auto_detect' => null,
'media_urls' => [
],
'messaging_profile_id' => '',
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'auto_detect' => null,
'media_urls' => [
],
'messaging_profile_id' => '',
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/messages/number_pool');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messages/number_pool' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"auto_detect": false,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messages/number_pool' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"auto_detect": false,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/messages/number_pool", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messages/number_pool"
payload = {
"auto_detect": False,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": False,
"webhook_failover_url": "",
"webhook_url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messages/number_pool"
payload <- "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messages/number_pool")
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 \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/messages/number_pool') do |req|
req.body = "{\n \"auto_detect\": false,\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages/number_pool";
let payload = json!({
"auto_detect": false,
"media_urls": (),
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/messages/number_pool \
--header 'content-type: application/json' \
--data '{
"auto_detect": false,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
echo '{
"auto_detect": false,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}' | \
http POST {{baseUrl}}/messages/number_pool \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "auto_detect": false,\n "media_urls": [],\n "messaging_profile_id": "",\n "subject": "",\n "text": "",\n "to": "",\n "type": "",\n "use_profile_webhooks": false,\n "webhook_failover_url": "",\n "webhook_url": ""\n}' \
--output-document \
- {{baseUrl}}/messages/number_pool
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"auto_detect": false,
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messages/number_pool")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"completed_at": null,
"cost": null,
"direction": "outbound",
"encoding": "GSM-7",
"errors": [],
"from": {
"carrier": "TELNYX LLC",
"line_type": "VoIP",
"phone_number": "+18445550001"
},
"id": "40385f64-5717-4562-b3fc-2c963f66afa6",
"media": [
{
"content_type": null,
"sha256": null,
"size": null,
"url": "https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png"
}
],
"messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
"organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
"parts": 1,
"received_at": "2019-01-23T18:10:02.574Z",
"record_type": "message",
"sent_at": null,
"subject": "From Telnyx!",
"tags": [
"Greetings"
],
"text": "Hello, World!",
"to": [
{
"carrier": "T-MOBILE USA, INC.",
"line_type": "Wireless",
"phone_number": "+18665550001",
"status": "queued"
}
],
"type": "MMS",
"valid_until": null,
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks"
}
}
POST
Send a message
{{baseUrl}}/messages
BODY json
{
"auto_detect": false,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messages");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/messages" {:content-type :json
:form-params {:auto_detect false
:from ""
:media_urls []
:messaging_profile_id ""
:subject ""
:text ""
:to ""
:type ""
:use_profile_webhooks false
:webhook_failover_url ""
:webhook_url ""}})
require "http/client"
url = "{{baseUrl}}/messages"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/messages"),
Content = new StringContent("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messages");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messages"
payload := strings.NewReader("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/messages HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 231
{
"auto_detect": false,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/messages")
.setHeader("content-type", "application/json")
.setBody("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messages"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/messages")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/messages")
.header("content-type", "application/json")
.body("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.asString();
const data = JSON.stringify({
auto_detect: false,
from: '',
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/messages');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/messages',
headers: {'content-type': 'application/json'},
data: {
auto_detect: false,
from: '',
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messages';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"auto_detect":false,"from":"","media_urls":[],"messaging_profile_id":"","subject":"","text":"","to":"","type":"","use_profile_webhooks":false,"webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messages',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "auto_detect": false,\n "from": "",\n "media_urls": [],\n "messaging_profile_id": "",\n "subject": "",\n "text": "",\n "to": "",\n "type": "",\n "use_profile_webhooks": false,\n "webhook_failover_url": "",\n "webhook_url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/messages")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/messages',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
auto_detect: false,
from: '',
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/messages',
headers: {'content-type': 'application/json'},
body: {
auto_detect: false,
from: '',
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/messages');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
auto_detect: false,
from: '',
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/messages',
headers: {'content-type': 'application/json'},
data: {
auto_detect: false,
from: '',
media_urls: [],
messaging_profile_id: '',
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messages';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"auto_detect":false,"from":"","media_urls":[],"messaging_profile_id":"","subject":"","text":"","to":"","type":"","use_profile_webhooks":false,"webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"auto_detect": @NO,
@"from": @"",
@"media_urls": @[ ],
@"messaging_profile_id": @"",
@"subject": @"",
@"text": @"",
@"to": @"",
@"type": @"",
@"use_profile_webhooks": @NO,
@"webhook_failover_url": @"",
@"webhook_url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messages"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messages" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messages",
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([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'messaging_profile_id' => '',
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]),
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;
}
request('POST', '{{baseUrl}}/messages', [
'body' => '{
"auto_detect": false,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/messages');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'messaging_profile_id' => '',
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'messaging_profile_id' => '',
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/messages');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messages' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"auto_detect": false,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messages' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"auto_detect": false,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/messages", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messages"
payload = {
"auto_detect": False,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": False,
"webhook_failover_url": "",
"webhook_url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messages"
payload <- "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messages")
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 \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/messages') do |req|
req.body = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"messaging_profile_id\": \"\",\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages";
let payload = json!({
"auto_detect": false,
"from": "",
"media_urls": (),
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/messages \
--header 'content-type: application/json' \
--data '{
"auto_detect": false,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
echo '{
"auto_detect": false,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}' | \
http POST {{baseUrl}}/messages \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "auto_detect": false,\n "from": "",\n "media_urls": [],\n "messaging_profile_id": "",\n "subject": "",\n "text": "",\n "to": "",\n "type": "",\n "use_profile_webhooks": false,\n "webhook_failover_url": "",\n "webhook_url": ""\n}' \
--output-document \
- {{baseUrl}}/messages
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"auto_detect": false,
"from": "",
"media_urls": [],
"messaging_profile_id": "",
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messages")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"completed_at": null,
"cost": null,
"direction": "outbound",
"encoding": "GSM-7",
"errors": [],
"from": {
"carrier": "TELNYX LLC",
"line_type": "VoIP",
"phone_number": "+18445550001"
},
"id": "40385f64-5717-4562-b3fc-2c963f66afa6",
"media": [
{
"content_type": null,
"sha256": null,
"size": null,
"url": "https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png"
}
],
"messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
"organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
"parts": 1,
"received_at": "2019-01-23T18:10:02.574Z",
"record_type": "message",
"sent_at": null,
"subject": "From Telnyx!",
"tags": [
"Greetings"
],
"text": "Hello, World!",
"to": [
{
"carrier": "T-MOBILE USA, INC.",
"line_type": "Wireless",
"phone_number": "+18665550001",
"status": "queued"
}
],
"type": "MMS",
"valid_until": null,
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks"
}
}
POST
Send a short code message
{{baseUrl}}/messages/short_code
BODY json
{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messages/short_code");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/messages/short_code" {:content-type :json
:form-params {:auto_detect false
:from ""
:media_urls []
:subject ""
:text ""
:to ""
:type ""
:use_profile_webhooks false
:webhook_failover_url ""
:webhook_url ""}})
require "http/client"
url = "{{baseUrl}}/messages/short_code"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/messages/short_code"),
Content = new StringContent("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messages/short_code");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messages/short_code"
payload := strings.NewReader("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/messages/short_code HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 201
{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/messages/short_code")
.setHeader("content-type", "application/json")
.setBody("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messages/short_code"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/messages/short_code")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/messages/short_code")
.header("content-type", "application/json")
.body("{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.asString();
const data = JSON.stringify({
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/messages/short_code');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/short_code',
headers: {'content-type': 'application/json'},
data: {
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messages/short_code';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"auto_detect":false,"from":"","media_urls":[],"subject":"","text":"","to":"","type":"","use_profile_webhooks":false,"webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messages/short_code',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "auto_detect": false,\n "from": "",\n "media_urls": [],\n "subject": "",\n "text": "",\n "to": "",\n "type": "",\n "use_profile_webhooks": false,\n "webhook_failover_url": "",\n "webhook_url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/messages/short_code")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/messages/short_code',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/short_code',
headers: {'content-type': 'application/json'},
body: {
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/messages/short_code');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/messages/short_code',
headers: {'content-type': 'application/json'},
data: {
auto_detect: false,
from: '',
media_urls: [],
subject: '',
text: '',
to: '',
type: '',
use_profile_webhooks: false,
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messages/short_code';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"auto_detect":false,"from":"","media_urls":[],"subject":"","text":"","to":"","type":"","use_profile_webhooks":false,"webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"auto_detect": @NO,
@"from": @"",
@"media_urls": @[ ],
@"subject": @"",
@"text": @"",
@"to": @"",
@"type": @"",
@"use_profile_webhooks": @NO,
@"webhook_failover_url": @"",
@"webhook_url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messages/short_code"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messages/short_code" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messages/short_code",
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([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]),
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;
}
request('POST', '{{baseUrl}}/messages/short_code', [
'body' => '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/messages/short_code');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'auto_detect' => null,
'from' => '',
'media_urls' => [
],
'subject' => '',
'text' => '',
'to' => '',
'type' => '',
'use_profile_webhooks' => null,
'webhook_failover_url' => '',
'webhook_url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/messages/short_code');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messages/short_code' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messages/short_code' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/messages/short_code", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messages/short_code"
payload = {
"auto_detect": False,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": False,
"webhook_failover_url": "",
"webhook_url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messages/short_code"
payload <- "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messages/short_code")
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 \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/messages/short_code') do |req|
req.body = "{\n \"auto_detect\": false,\n \"from\": \"\",\n \"media_urls\": [],\n \"subject\": \"\",\n \"text\": \"\",\n \"to\": \"\",\n \"type\": \"\",\n \"use_profile_webhooks\": false,\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages/short_code";
let payload = json!({
"auto_detect": false,
"from": "",
"media_urls": (),
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/messages/short_code \
--header 'content-type: application/json' \
--data '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}'
echo '{
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
}' | \
http POST {{baseUrl}}/messages/short_code \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "auto_detect": false,\n "from": "",\n "media_urls": [],\n "subject": "",\n "text": "",\n "to": "",\n "type": "",\n "use_profile_webhooks": false,\n "webhook_failover_url": "",\n "webhook_url": ""\n}' \
--output-document \
- {{baseUrl}}/messages/short_code
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"auto_detect": false,
"from": "",
"media_urls": [],
"subject": "",
"text": "",
"to": "",
"type": "",
"use_profile_webhooks": false,
"webhook_failover_url": "",
"webhook_url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messages/short_code")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"completed_at": null,
"cost": null,
"direction": "outbound",
"encoding": "GSM-7",
"errors": [],
"from": {
"carrier": "TELNYX LLC",
"line_type": "VoIP",
"phone_number": "+18445550001"
},
"id": "40385f64-5717-4562-b3fc-2c963f66afa6",
"media": [
{
"content_type": null,
"sha256": null,
"size": null,
"url": "https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png"
}
],
"messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6",
"organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950",
"parts": 1,
"received_at": "2019-01-23T18:10:02.574Z",
"record_type": "message",
"sent_at": null,
"subject": "From Telnyx!",
"tags": [
"Greetings"
],
"text": "Hello, World!",
"to": [
{
"carrier": "T-MOBILE USA, INC.",
"line_type": "Wireless",
"phone_number": "+18665550001",
"status": "queued"
}
],
"type": "MMS",
"valid_until": null,
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks"
}
}
POST
Create a messaging hosted number order
{{baseUrl}}/messaging_hosted_number_orders
BODY json
{
"messaging_profile_id": "",
"phone_numbers": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_hosted_number_orders");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/messaging_hosted_number_orders" {:content-type :json
:form-params {:messaging_profile_id ""
:phone_numbers []}})
require "http/client"
url = "{{baseUrl}}/messaging_hosted_number_orders"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/messaging_hosted_number_orders"),
Content = new StringContent("{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_hosted_number_orders");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_hosted_number_orders"
payload := strings.NewReader("{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/messaging_hosted_number_orders HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 55
{
"messaging_profile_id": "",
"phone_numbers": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/messaging_hosted_number_orders")
.setHeader("content-type", "application/json")
.setBody("{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_hosted_number_orders"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_hosted_number_orders")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/messaging_hosted_number_orders")
.header("content-type", "application/json")
.body("{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}")
.asString();
const data = JSON.stringify({
messaging_profile_id: '',
phone_numbers: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/messaging_hosted_number_orders');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_hosted_number_orders',
headers: {'content-type': 'application/json'},
data: {messaging_profile_id: '', phone_numbers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_hosted_number_orders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"messaging_profile_id":"","phone_numbers":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_hosted_number_orders',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "messaging_profile_id": "",\n "phone_numbers": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/messaging_hosted_number_orders")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_hosted_number_orders',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({messaging_profile_id: '', phone_numbers: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_hosted_number_orders',
headers: {'content-type': 'application/json'},
body: {messaging_profile_id: '', phone_numbers: []},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/messaging_hosted_number_orders');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
messaging_profile_id: '',
phone_numbers: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_hosted_number_orders',
headers: {'content-type': 'application/json'},
data: {messaging_profile_id: '', phone_numbers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_hosted_number_orders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"messaging_profile_id":"","phone_numbers":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"messaging_profile_id": @"",
@"phone_numbers": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_hosted_number_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_hosted_number_orders" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_hosted_number_orders",
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([
'messaging_profile_id' => '',
'phone_numbers' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/messaging_hosted_number_orders', [
'body' => '{
"messaging_profile_id": "",
"phone_numbers": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_hosted_number_orders');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'messaging_profile_id' => '',
'phone_numbers' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'messaging_profile_id' => '',
'phone_numbers' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/messaging_hosted_number_orders');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_hosted_number_orders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"messaging_profile_id": "",
"phone_numbers": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_hosted_number_orders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"messaging_profile_id": "",
"phone_numbers": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/messaging_hosted_number_orders", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_hosted_number_orders"
payload = {
"messaging_profile_id": "",
"phone_numbers": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_hosted_number_orders"
payload <- "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_hosted_number_orders")
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 \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/messaging_hosted_number_orders') do |req|
req.body = "{\n \"messaging_profile_id\": \"\",\n \"phone_numbers\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_hosted_number_orders";
let payload = json!({
"messaging_profile_id": "",
"phone_numbers": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/messaging_hosted_number_orders \
--header 'content-type: application/json' \
--data '{
"messaging_profile_id": "",
"phone_numbers": []
}'
echo '{
"messaging_profile_id": "",
"phone_numbers": []
}' | \
http POST {{baseUrl}}/messaging_hosted_number_orders \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "messaging_profile_id": "",\n "phone_numbers": []\n}' \
--output-document \
- {{baseUrl}}/messaging_hosted_number_orders
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"messaging_profile_id": "",
"phone_numbers": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_hosted_number_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"messaging_profile_id": "dc8f39ac-953d-4520-b93b-786ae87db0da",
"phone_numbers": [
{
"id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c",
"phone_number": "+18665550001",
"record_type": "messaging_hosted_number",
"status": "pending"
},
{
"id": "464bd54e-a328-4b11-a131-28e6793cb6f2",
"phone_number": "+18665550002",
"record_type": "messaging_hosted_number",
"status": "pending"
}
],
"record_type": "messaging_hosted_number_order",
"status": "pending"
}
}
DELETE
Delete a messaging hosted number
{{baseUrl}}/messaging_hosted_numbers/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_hosted_numbers/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/messaging_hosted_numbers/:id")
require "http/client"
url = "{{baseUrl}}/messaging_hosted_numbers/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/messaging_hosted_numbers/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_hosted_numbers/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_hosted_numbers/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/messaging_hosted_numbers/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/messaging_hosted_numbers/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_hosted_numbers/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_hosted_numbers/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/messaging_hosted_numbers/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/messaging_hosted_numbers/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/messaging_hosted_numbers/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_hosted_numbers/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_hosted_numbers/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_hosted_numbers/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_hosted_numbers/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/messaging_hosted_numbers/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/messaging_hosted_numbers/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/messaging_hosted_numbers/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_hosted_numbers/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_hosted_numbers/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_hosted_numbers/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_hosted_numbers/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/messaging_hosted_numbers/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_hosted_numbers/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_hosted_numbers/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_hosted_numbers/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_hosted_numbers/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/messaging_hosted_numbers/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_hosted_numbers/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_hosted_numbers/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_hosted_numbers/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/messaging_hosted_numbers/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_hosted_numbers/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/messaging_hosted_numbers/:id
http DELETE {{baseUrl}}/messaging_hosted_numbers/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/messaging_hosted_numbers/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_hosted_numbers/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c",
"phone_number": "+18665550001",
"record_type": "messaging_hosted_number",
"status": "successful"
}
]
}
GET
List messaging hosted number orders
{{baseUrl}}/messaging_hosted_number_orders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_hosted_number_orders");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_hosted_number_orders")
require "http/client"
url = "{{baseUrl}}/messaging_hosted_number_orders"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_hosted_number_orders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_hosted_number_orders");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_hosted_number_orders"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_hosted_number_orders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_hosted_number_orders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_hosted_number_orders"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_hosted_number_orders")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_hosted_number_orders")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_hosted_number_orders');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_hosted_number_orders'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_hosted_number_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_hosted_number_orders',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_hosted_number_orders")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_hosted_number_orders',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_hosted_number_orders'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_hosted_number_orders');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_hosted_number_orders'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_hosted_number_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_hosted_number_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_hosted_number_orders" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_hosted_number_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_hosted_number_orders');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_hosted_number_orders');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_hosted_number_orders');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_hosted_number_orders' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_hosted_number_orders' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_hosted_number_orders")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_hosted_number_orders"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_hosted_number_orders"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_hosted_number_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_hosted_number_orders') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_hosted_number_orders";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_hosted_number_orders
http GET {{baseUrl}}/messaging_hosted_number_orders
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_hosted_number_orders
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_hosted_number_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"messaging_profile_id": "dc8f39ac-953d-4520-b93b-786ae87db0da",
"phone_numbers": [
{
"id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c",
"phone_number": "+18665550001",
"record_type": "messaging_hosted_number",
"status": "pending"
},
{
"id": "464bd54e-a328-4b11-a131-28e6793cb6f2",
"phone_number": "+18665550002",
"record_type": "messaging_hosted_number",
"status": "pending"
}
],
"record_type": "messaging_hosted_number_order",
"status": "pending"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a messaging hosted number order
{{baseUrl}}/messaging_hosted_number_orders/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_hosted_number_orders/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_hosted_number_orders/:id")
require "http/client"
url = "{{baseUrl}}/messaging_hosted_number_orders/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_hosted_number_orders/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_hosted_number_orders/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_hosted_number_orders/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_hosted_number_orders/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_hosted_number_orders/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_hosted_number_orders/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_hosted_number_orders/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_hosted_number_orders/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_hosted_number_orders/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_hosted_number_orders/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_hosted_number_orders/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_hosted_number_orders/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_hosted_number_orders/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_hosted_number_orders/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_hosted_number_orders/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_hosted_number_orders/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_hosted_number_orders/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_hosted_number_orders/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_hosted_number_orders/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_hosted_number_orders/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_hosted_number_orders/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_hosted_number_orders/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_hosted_number_orders/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_hosted_number_orders/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_hosted_number_orders/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_hosted_number_orders/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_hosted_number_orders/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_hosted_number_orders/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_hosted_number_orders/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_hosted_number_orders/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_hosted_number_orders/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_hosted_number_orders/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_hosted_number_orders/:id
http GET {{baseUrl}}/messaging_hosted_number_orders/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_hosted_number_orders/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_hosted_number_orders/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"messaging_profile_id": "dc8f39ac-953d-4520-b93b-786ae87db0da",
"phone_numbers": [
{
"id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c",
"phone_number": "+18665550001",
"record_type": "messaging_hosted_number",
"status": "pending"
},
{
"id": "464bd54e-a328-4b11-a131-28e6793cb6f2",
"phone_number": "+18665550002",
"record_type": "messaging_hosted_number",
"status": "pending"
}
],
"record_type": "messaging_hosted_number_order",
"status": "pending"
}
}
POST
Upload file required for a messaging hosted number order
{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload
QUERY PARAMS
id
BODY multipartForm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload" {:multipart [{:name "bill"
:content ""} {:name "loa"
:content ""}]})
require "http/client"
url = "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload"
headers = HTTP::Headers{
"content-type" => "multipart/form-data; boundary=---011000010111000001101001"
}
reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload"),
Content = new MultipartFormDataContent
{
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "bill",
}
}
},
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "loa",
}
}
},
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/messaging_hosted_number_orders/:id/actions/file_upload HTTP/1.1
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Host: example.com
Content-Length: 192
-----011000010111000001101001
Content-Disposition: form-data; name="bill"
-----011000010111000001101001
Content-Disposition: form-data; name="loa"
-----011000010111000001101001--
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload")
.setHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.setBody("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload"))
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.method("POST", HttpRequest.BodyPublishers.ofString("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload")
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.asString();
const data = new FormData();
data.append('bill', '');
data.append('loa', '');
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload');
xhr.send(data);
import axios from 'axios';
const form = new FormData();
form.append('bill', '');
form.append('loa', '');
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '[form]'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload';
const form = new FormData();
form.append('bill', '');
form.append('loa', '');
const options = {method: 'POST'};
options.body = form;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const form = new FormData();
form.append('bill', '');
form.append('loa', '');
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload',
method: 'POST',
headers: {},
processData: false,
contentType: false,
mimeType: 'multipart/form-data',
data: form
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001")
val body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
val request = Request.Builder()
.url("{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_hosted_number_orders/:id/actions/file_upload',
headers: {
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write('-----011000010111000001101001\r\nContent-Disposition: form-data; name="bill"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="loa"\r\n\r\n\r\n-----011000010111000001101001--\r\n');
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
formData: {bill: '', loa: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload');
req.headers({
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
});
req.multipart([]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '-----011000010111000001101001\r\nContent-Disposition: form-data; name="bill"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="loa"\r\n\r\n\r\n-----011000010111000001101001--\r\n'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();
formData.append('bill', '');
formData.append('loa', '');
const url = '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload';
const options = {method: 'POST'};
options.body = formData;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"multipart/form-data; boundary=---011000010111000001101001" };
NSArray *parameters = @[ @{ @"name": @"bill", @"value": @"" },
@{ @"name": @"loa", @"value": @"" } ];
NSString *boundary = @"---011000010111000001101001";
NSError *error;
NSMutableString *body = [NSMutableString string];
for (NSDictionary *param in parameters) {
[body appendFormat:@"--%@\r\n", boundary];
if (param[@"fileName"]) {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"; filename=\"%@\"\r\n", param[@"name"], param[@"fileName"]];
[body appendFormat:@"Content-Type: %@\r\n\r\n", param[@"contentType"]];
[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];
if (error) {
NSLog(@"%@", error);
}
} else {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"\r\n\r\n", param[@"name"]];
[body appendFormat:@"%@", param[@"value"]];
}
}
[body appendFormat:@"\r\n--%@--\r\n", boundary];
NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload" in
let headers = Header.add (Header.init ()) "content-type" "multipart/form-data; boundary=---011000010111000001101001" in
let body = Cohttp_lwt_body.of_string "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n",
CURLOPT_HTTPHEADER => [
"content-type: multipart/form-data; boundary=---011000010111000001101001"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload', [
'headers' => [
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001'
]);
$request->setBody('-----011000010111000001101001
Content-Disposition: form-data; name="bill"
-----011000010111000001101001
Content-Disposition: form-data; name="loa"
-----011000010111000001101001--
');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
addForm(null, null);
$request->setRequestUrl('{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload');
$request->setRequestMethod('POST');
$request->setBody($body);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="bill"
-----011000010111000001101001
Content-Disposition: form-data; name="loa"
-----011000010111000001101001--
'
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="bill"
-----011000010111000001101001
Content-Disposition: form-data; name="loa"
-----011000010111000001101001--
'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = { 'content-type': "multipart/form-data; boundary=---011000010111000001101001" }
conn.request("POST", "/baseUrl/messaging_hosted_number_orders/:id/actions/file_upload", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"content-type": "multipart/form-data; boundary=---011000010111000001101001"}
response = requests.post(url, data=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload"
payload <- "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
encode <- "multipart"
response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001'}
)
response = conn.post('/baseUrl/messaging_hosted_number_orders/:id/actions/file_upload') do |req|
req.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"loa\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload";
let form = reqwest::multipart::Form::new()
.text("bill", "")
.text("loa", "");
let mut headers = reqwest::header::HeaderMap::new();
let client = reqwest::Client::new();
let response = client.post(url)
.multipart(form)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload \
--header 'content-type: multipart/form-data' \
--form bill= \
--form loa=
echo '-----011000010111000001101001
Content-Disposition: form-data; name="bill"
-----011000010111000001101001
Content-Disposition: form-data; name="loa"
-----011000010111000001101001--
' | \
http POST {{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload \
content-type:'multipart/form-data; boundary=---011000010111000001101001'
wget --quiet \
--method POST \
--header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
--body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="bill"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="loa"\r\n\r\n\r\n-----011000010111000001101001--\r\n' \
--output-document \
- {{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload
import Foundation
let headers = ["content-type": "multipart/form-data; boundary=---011000010111000001101001"]
let parameters = [
[
"name": "bill",
"value": ""
],
[
"name": "loa",
"value": ""
]
]
let boundary = "---011000010111000001101001"
var body = ""
var error: NSError? = nil
for param in parameters {
let paramName = param["name"]!
body += "--\(boundary)\r\n"
body += "Content-Disposition:form-data; name=\"\(paramName)\""
if let filename = param["fileName"] {
let contentType = param["content-type"]!
let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
if (error != nil) {
print(error as Any)
}
body += "; filename=\"\(filename)\"\r\n"
body += "Content-Type: \(contentType)\r\n\r\n"
body += fileContent
} else if let paramValue = param["value"] {
body += "\r\n\r\n\(paramValue)"
}
}
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_hosted_number_orders/:id/actions/file_upload")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"messaging_profile_id": "dc8f39ac-953d-4520-b93b-786ae87db0da",
"phone_numbers": [
{
"id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c",
"phone_number": "+18665550001",
"record_type": "messaging_hosted_number",
"status": "pending"
},
{
"id": "464bd54e-a328-4b11-a131-28e6793cb6f2",
"phone_number": "+18665550002",
"record_type": "messaging_hosted_number",
"status": "pending"
}
],
"record_type": "messaging_hosted_number_order",
"status": "pending"
}
}
POST
Create a messaging profile
{{baseUrl}}/messaging_profiles
BODY json
{
"enabled": false,
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profiles");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/messaging_profiles" {:content-type :json
:form-params {:enabled false
:name ""
:number_pool_settings {:geomatch false
:long_code_weight ""
:skip_unhealthy false
:sticky_sender false
:toll_free_weight ""}
:url_shortener_settings {:domain ""
:prefix ""
:replace_blacklist_only false
:send_webhooks false}
:webhook_api_version ""
:webhook_failover_url ""
:webhook_url ""}})
require "http/client"
url = "{{baseUrl}}/messaging_profiles"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/messaging_profiles"),
Content = new StringContent("{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profiles");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profiles"
payload := strings.NewReader("{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/messaging_profiles HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 419
{
"enabled": false,
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/messaging_profiles")
.setHeader("content-type", "application/json")
.setBody("{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profiles"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profiles")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/messaging_profiles")
.header("content-type", "application/json")
.body("{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
.asString();
const data = JSON.stringify({
enabled: false,
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
url_shortener_settings: {
domain: '',
prefix: '',
replace_blacklist_only: false,
send_webhooks: false
},
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/messaging_profiles');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_profiles',
headers: {'content-type': 'application/json'},
data: {
enabled: false,
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
url_shortener_settings: {domain: '', prefix: '', replace_blacklist_only: false, send_webhooks: false},
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profiles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"enabled":false,"name":"","number_pool_settings":{"geomatch":false,"long_code_weight":"","skip_unhealthy":false,"sticky_sender":false,"toll_free_weight":""},"url_shortener_settings":{"domain":"","prefix":"","replace_blacklist_only":false,"send_webhooks":false},"webhook_api_version":"","webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profiles',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "enabled": false,\n "name": "",\n "number_pool_settings": {\n "geomatch": false,\n "long_code_weight": "",\n "skip_unhealthy": false,\n "sticky_sender": false,\n "toll_free_weight": ""\n },\n "url_shortener_settings": {\n "domain": "",\n "prefix": "",\n "replace_blacklist_only": false,\n "send_webhooks": false\n },\n "webhook_api_version": "",\n "webhook_failover_url": "",\n "webhook_url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profiles")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profiles',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
enabled: false,
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
url_shortener_settings: {domain: '', prefix: '', replace_blacklist_only: false, send_webhooks: false},
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_profiles',
headers: {'content-type': 'application/json'},
body: {
enabled: false,
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
url_shortener_settings: {domain: '', prefix: '', replace_blacklist_only: false, send_webhooks: false},
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/messaging_profiles');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
enabled: false,
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
url_shortener_settings: {
domain: '',
prefix: '',
replace_blacklist_only: false,
send_webhooks: false
},
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/messaging_profiles',
headers: {'content-type': 'application/json'},
data: {
enabled: false,
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
url_shortener_settings: {domain: '', prefix: '', replace_blacklist_only: false, send_webhooks: false},
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profiles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"enabled":false,"name":"","number_pool_settings":{"geomatch":false,"long_code_weight":"","skip_unhealthy":false,"sticky_sender":false,"toll_free_weight":""},"url_shortener_settings":{"domain":"","prefix":"","replace_blacklist_only":false,"send_webhooks":false},"webhook_api_version":"","webhook_failover_url":"","webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"enabled": @NO,
@"name": @"",
@"number_pool_settings": @{ @"geomatch": @NO, @"long_code_weight": @"", @"skip_unhealthy": @NO, @"sticky_sender": @NO, @"toll_free_weight": @"" },
@"url_shortener_settings": @{ @"domain": @"", @"prefix": @"", @"replace_blacklist_only": @NO, @"send_webhooks": @NO },
@"webhook_api_version": @"",
@"webhook_failover_url": @"",
@"webhook_url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profiles"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profiles" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profiles",
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([
'enabled' => null,
'name' => '',
'number_pool_settings' => [
'geomatch' => null,
'long_code_weight' => '',
'skip_unhealthy' => null,
'sticky_sender' => null,
'toll_free_weight' => ''
],
'url_shortener_settings' => [
'domain' => '',
'prefix' => '',
'replace_blacklist_only' => null,
'send_webhooks' => null
],
'webhook_api_version' => '',
'webhook_failover_url' => '',
'webhook_url' => ''
]),
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;
}
request('POST', '{{baseUrl}}/messaging_profiles', [
'body' => '{
"enabled": false,
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profiles');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'enabled' => null,
'name' => '',
'number_pool_settings' => [
'geomatch' => null,
'long_code_weight' => '',
'skip_unhealthy' => null,
'sticky_sender' => null,
'toll_free_weight' => ''
],
'url_shortener_settings' => [
'domain' => '',
'prefix' => '',
'replace_blacklist_only' => null,
'send_webhooks' => null
],
'webhook_api_version' => '',
'webhook_failover_url' => '',
'webhook_url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'enabled' => null,
'name' => '',
'number_pool_settings' => [
'geomatch' => null,
'long_code_weight' => '',
'skip_unhealthy' => null,
'sticky_sender' => null,
'toll_free_weight' => ''
],
'url_shortener_settings' => [
'domain' => '',
'prefix' => '',
'replace_blacklist_only' => null,
'send_webhooks' => null
],
'webhook_api_version' => '',
'webhook_failover_url' => '',
'webhook_url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/messaging_profiles');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"enabled": false,
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"enabled": false,
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/messaging_profiles", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profiles"
payload = {
"enabled": False,
"name": "",
"number_pool_settings": {
"geomatch": False,
"long_code_weight": "",
"skip_unhealthy": False,
"sticky_sender": False,
"toll_free_weight": ""
},
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": False,
"send_webhooks": False
},
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profiles"
payload <- "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profiles")
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 \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/messaging_profiles') do |req|
req.body = "{\n \"enabled\": false,\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profiles";
let payload = json!({
"enabled": false,
"name": "",
"number_pool_settings": json!({
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
}),
"url_shortener_settings": json!({
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
}),
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/messaging_profiles \
--header 'content-type: application/json' \
--data '{
"enabled": false,
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
}'
echo '{
"enabled": false,
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
}' | \
http POST {{baseUrl}}/messaging_profiles \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "enabled": false,\n "name": "",\n "number_pool_settings": {\n "geomatch": false,\n "long_code_weight": "",\n "skip_unhealthy": false,\n "sticky_sender": false,\n "toll_free_weight": ""\n },\n "url_shortener_settings": {\n "domain": "",\n "prefix": "",\n "replace_blacklist_only": false,\n "send_webhooks": false\n },\n "webhook_api_version": "",\n "webhook_failover_url": "",\n "webhook_url": ""\n}' \
--output-document \
- {{baseUrl}}/messaging_profiles
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"enabled": false,
"name": "",
"number_pool_settings": [
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
],
"url_shortener_settings": [
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
],
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profiles")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-01-23T18:10:02.574Z",
"enabled": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Profile for Messages",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": 2,
"skip_unhealthy": false,
"sticky_sender": true,
"toll_free_weight": 10
},
"record_type": "messaging_profile",
"updated_at": "2019-01-23T18:10:02.574Z",
"url_shortener_settings": {
"domain": "example.ex",
"prefix": "cmpny",
"replace_blacklist_only": true,
"send_webhooks": false
},
"v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
"webhook_api_version": "2",
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks",
"whitelisted_destinations": [
"US"
]
}
}
DELETE
Delete a messaging profile
{{baseUrl}}/messaging_profiles/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profiles/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/messaging_profiles/:id")
require "http/client"
url = "{{baseUrl}}/messaging_profiles/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/messaging_profiles/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profiles/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profiles/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/messaging_profiles/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/messaging_profiles/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profiles/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/messaging_profiles/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/messaging_profiles/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/messaging_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profiles/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profiles/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profiles/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/messaging_profiles/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/messaging_profiles/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/messaging_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profiles/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profiles/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profiles/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/messaging_profiles/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profiles/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_profiles/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profiles/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profiles/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/messaging_profiles/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profiles/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profiles/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/messaging_profiles/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profiles/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/messaging_profiles/:id
http DELETE {{baseUrl}}/messaging_profiles/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/messaging_profiles/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-01-23T18:10:02.574Z",
"enabled": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Profile for Messages",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": 2,
"skip_unhealthy": false,
"sticky_sender": true,
"toll_free_weight": 10
},
"record_type": "messaging_profile",
"updated_at": "2019-01-23T18:10:02.574Z",
"url_shortener_settings": {
"domain": "example.ex",
"prefix": "cmpny",
"replace_blacklist_only": true,
"send_webhooks": false
},
"v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
"webhook_api_version": "2",
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks",
"whitelisted_destinations": [
"US"
]
}
}
GET
List messaging profile metrics
{{baseUrl}}/messaging_profile_metrics
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profile_metrics");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_profile_metrics")
require "http/client"
url = "{{baseUrl}}/messaging_profile_metrics"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_profile_metrics"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profile_metrics");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profile_metrics"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_profile_metrics HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_profile_metrics")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profile_metrics"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profile_metrics")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_profile_metrics")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_profile_metrics');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profile_metrics'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profile_metrics';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profile_metrics',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profile_metrics")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profile_metrics',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profile_metrics'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_profile_metrics');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profile_metrics'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profile_metrics';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profile_metrics"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profile_metrics" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profile_metrics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_profile_metrics');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profile_metrics');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_profile_metrics');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profile_metrics' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profile_metrics' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_profile_metrics")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profile_metrics"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profile_metrics"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profile_metrics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_profile_metrics') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profile_metrics";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_profile_metrics
http GET {{baseUrl}}/messaging_profile_metrics
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_profile_metrics
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profile_metrics")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"inbound": {
"received": 850
},
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"outbound": {
"delivered": 990,
"errors": 0.01,
"sent": 1000
},
"phone_numbers": 250,
"record_type": "messaging_profile_metrics"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List messaging profiles
{{baseUrl}}/messaging_profiles
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profiles");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_profiles")
require "http/client"
url = "{{baseUrl}}/messaging_profiles"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_profiles"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profiles");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profiles"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_profiles HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_profiles")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profiles"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profiles")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_profiles")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_profiles');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profiles';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profiles',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profiles")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profiles',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profiles'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_profiles');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profiles';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profiles"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profiles" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_profiles');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profiles');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_profiles');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profiles' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profiles' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_profiles")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profiles"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profiles"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_profiles') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profiles";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_profiles
http GET {{baseUrl}}/messaging_profiles
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_profiles
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profiles")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"created_at": "2019-01-23T18:10:02.574Z",
"enabled": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Profile for Messages",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": 2,
"skip_unhealthy": false,
"sticky_sender": true,
"toll_free_weight": 10
},
"record_type": "messaging_profile",
"updated_at": "2019-01-23T18:10:02.574Z",
"url_shortener_settings": {
"domain": "example.ex",
"prefix": "cmpny",
"replace_blacklist_only": true,
"send_webhooks": false
},
"v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
"webhook_api_version": "2",
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks",
"whitelisted_destinations": [
"US"
]
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List phone numbers associated with a messaging profile
{{baseUrl}}/messaging_profiles/:id/phone_numbers
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profiles/:id/phone_numbers");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_profiles/:id/phone_numbers")
require "http/client"
url = "{{baseUrl}}/messaging_profiles/:id/phone_numbers"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_profiles/:id/phone_numbers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profiles/:id/phone_numbers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profiles/:id/phone_numbers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_profiles/:id/phone_numbers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_profiles/:id/phone_numbers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profiles/:id/phone_numbers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id/phone_numbers")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_profiles/:id/phone_numbers")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_profiles/:id/phone_numbers');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/phone_numbers'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profiles/:id/phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profiles/:id/phone_numbers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id/phone_numbers")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profiles/:id/phone_numbers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/phone_numbers'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_profiles/:id/phone_numbers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/phone_numbers'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profiles/:id/phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profiles/:id/phone_numbers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profiles/:id/phone_numbers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profiles/:id/phone_numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_profiles/:id/phone_numbers');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profiles/:id/phone_numbers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_profiles/:id/phone_numbers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profiles/:id/phone_numbers' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profiles/:id/phone_numbers' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_profiles/:id/phone_numbers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profiles/:id/phone_numbers"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profiles/:id/phone_numbers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profiles/:id/phone_numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_profiles/:id/phone_numbers') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profiles/:id/phone_numbers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_profiles/:id/phone_numbers
http GET {{baseUrl}}/messaging_profiles/:id/phone_numbers
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_profiles/:id/phone_numbers
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profiles/:id/phone_numbers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"eligible_messaging_products": [
"A2P"
],
"features": {
"mms": null,
"sms": {
"domestic_two_way": true,
"international_inbound": true,
"international_outbound": true
}
},
"health": {
"inbound_outbound_ratio": 0.43,
"message_count": 122,
"spam_ratio": 0.06,
"success_ratio": 0.94
},
"id": "1293384261075731499",
"messaging_product": "A2P",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"phone_number": "+18005550001",
"record_type": "messaging_settings",
"traffic_type": "A2P",
"type": "toll-free",
"updated_at": "2019-01-23T18:10:02.574Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List short codes associated with a messaging profile
{{baseUrl}}/messaging_profiles/:id/short_codes
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profiles/:id/short_codes");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_profiles/:id/short_codes")
require "http/client"
url = "{{baseUrl}}/messaging_profiles/:id/short_codes"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_profiles/:id/short_codes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profiles/:id/short_codes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profiles/:id/short_codes"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_profiles/:id/short_codes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_profiles/:id/short_codes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profiles/:id/short_codes"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id/short_codes")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_profiles/:id/short_codes")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_profiles/:id/short_codes');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/short_codes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profiles/:id/short_codes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profiles/:id/short_codes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id/short_codes")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profiles/:id/short_codes',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/short_codes'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_profiles/:id/short_codes');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/short_codes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profiles/:id/short_codes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profiles/:id/short_codes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profiles/:id/short_codes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profiles/:id/short_codes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_profiles/:id/short_codes');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profiles/:id/short_codes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_profiles/:id/short_codes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profiles/:id/short_codes' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profiles/:id/short_codes' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_profiles/:id/short_codes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profiles/:id/short_codes"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profiles/:id/short_codes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profiles/:id/short_codes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_profiles/:id/short_codes') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profiles/:id/short_codes";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_profiles/:id/short_codes
http GET {{baseUrl}}/messaging_profiles/:id/short_codes
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_profiles/:id/short_codes
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profiles/:id/short_codes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"record_type": "short_code",
"short_code": "12345",
"updated_at": "2019-01-23T18:10:02.574Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a messaging profile
{{baseUrl}}/messaging_profiles/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profiles/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_profiles/:id")
require "http/client"
url = "{{baseUrl}}/messaging_profiles/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_profiles/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profiles/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profiles/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_profiles/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_profiles/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profiles/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_profiles/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_profiles/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profiles/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profiles/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profiles/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profiles/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_profiles/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/messaging_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profiles/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profiles/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profiles/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_profiles/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profiles/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_profiles/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profiles/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profiles/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_profiles/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profiles/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profiles/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_profiles/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profiles/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_profiles/:id
http GET {{baseUrl}}/messaging_profiles/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_profiles/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-01-23T18:10:02.574Z",
"enabled": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Profile for Messages",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": 2,
"skip_unhealthy": false,
"sticky_sender": true,
"toll_free_weight": 10
},
"record_type": "messaging_profile",
"updated_at": "2019-01-23T18:10:02.574Z",
"url_shortener_settings": {
"domain": "example.ex",
"prefix": "cmpny",
"replace_blacklist_only": true,
"send_webhooks": false
},
"v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
"webhook_api_version": "2",
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks",
"whitelisted_destinations": [
"US"
]
}
}
GET
Retrieve messaging profile metrics
{{baseUrl}}/messaging_profiles/:id/metrics
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profiles/:id/metrics");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_profiles/:id/metrics")
require "http/client"
url = "{{baseUrl}}/messaging_profiles/:id/metrics"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_profiles/:id/metrics"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profiles/:id/metrics");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profiles/:id/metrics"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_profiles/:id/metrics HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_profiles/:id/metrics")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profiles/:id/metrics"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id/metrics")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_profiles/:id/metrics")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_profiles/:id/metrics');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/metrics'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profiles/:id/metrics';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profiles/:id/metrics',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id/metrics")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profiles/:id/metrics',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/metrics'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_profiles/:id/metrics');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/messaging_profiles/:id/metrics'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profiles/:id/metrics';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profiles/:id/metrics"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profiles/:id/metrics" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profiles/:id/metrics",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_profiles/:id/metrics');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profiles/:id/metrics');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_profiles/:id/metrics');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profiles/:id/metrics' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profiles/:id/metrics' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_profiles/:id/metrics")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profiles/:id/metrics"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profiles/:id/metrics"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profiles/:id/metrics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_profiles/:id/metrics') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profiles/:id/metrics";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_profiles/:id/metrics
http GET {{baseUrl}}/messaging_profiles/:id/metrics
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_profiles/:id/metrics
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profiles/:id/metrics")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"detailed": [
{
"metrics": [
{
"delivered": 990,
"errors": 0.01,
"label": "longcode",
"received": 750,
"sent": 1000
}
],
"timestamp": "2019-01-23T18:10:02.574Z"
}
],
"overview": {
"inbound": {
"received": 850
},
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"outbound": {
"delivered": 990,
"errors": 0.01,
"sent": 1000
},
"phone_numbers": 250,
"record_type": "messaging_profile_metrics"
}
}
}
PATCH
Update a messaging profile
{{baseUrl}}/messaging_profiles/:id
QUERY PARAMS
id
BODY json
{
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"record_type": "",
"updated_at": "",
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_profiles/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/messaging_profiles/:id" {:content-type :json
:form-params {:created_at ""
:enabled false
:id ""
:name ""
:number_pool_settings {:geomatch false
:long_code_weight ""
:skip_unhealthy false
:sticky_sender false
:toll_free_weight ""}
:record_type ""
:updated_at ""
:url_shortener_settings {:domain ""
:prefix ""
:replace_blacklist_only false
:send_webhooks false}
:v1_secret ""
:webhook_api_version ""
:webhook_failover_url ""
:webhook_url ""
:whitelisted_destinations []}})
require "http/client"
url = "{{baseUrl}}/messaging_profiles/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/messaging_profiles/:id"),
Content = new StringContent("{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_profiles/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_profiles/:id"
payload := strings.NewReader("{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/messaging_profiles/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 545
{
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"record_type": "",
"updated_at": "",
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/messaging_profiles/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_profiles/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/messaging_profiles/:id")
.header("content-type", "application/json")
.body("{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}")
.asString();
const data = JSON.stringify({
created_at: '',
enabled: false,
id: '',
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
record_type: '',
updated_at: '',
url_shortener_settings: {
domain: '',
prefix: '',
replace_blacklist_only: false,
send_webhooks: false
},
v1_secret: '',
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: '',
whitelisted_destinations: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/messaging_profiles/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/messaging_profiles/:id',
headers: {'content-type': 'application/json'},
data: {
created_at: '',
enabled: false,
id: '',
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
record_type: '',
updated_at: '',
url_shortener_settings: {domain: '', prefix: '', replace_blacklist_only: false, send_webhooks: false},
v1_secret: '',
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: '',
whitelisted_destinations: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_profiles/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"created_at":"","enabled":false,"id":"","name":"","number_pool_settings":{"geomatch":false,"long_code_weight":"","skip_unhealthy":false,"sticky_sender":false,"toll_free_weight":""},"record_type":"","updated_at":"","url_shortener_settings":{"domain":"","prefix":"","replace_blacklist_only":false,"send_webhooks":false},"v1_secret":"","webhook_api_version":"","webhook_failover_url":"","webhook_url":"","whitelisted_destinations":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_profiles/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "created_at": "",\n "enabled": false,\n "id": "",\n "name": "",\n "number_pool_settings": {\n "geomatch": false,\n "long_code_weight": "",\n "skip_unhealthy": false,\n "sticky_sender": false,\n "toll_free_weight": ""\n },\n "record_type": "",\n "updated_at": "",\n "url_shortener_settings": {\n "domain": "",\n "prefix": "",\n "replace_blacklist_only": false,\n "send_webhooks": false\n },\n "v1_secret": "",\n "webhook_api_version": "",\n "webhook_failover_url": "",\n "webhook_url": "",\n "whitelisted_destinations": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/messaging_profiles/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_profiles/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
created_at: '',
enabled: false,
id: '',
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
record_type: '',
updated_at: '',
url_shortener_settings: {domain: '', prefix: '', replace_blacklist_only: false, send_webhooks: false},
v1_secret: '',
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: '',
whitelisted_destinations: []
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/messaging_profiles/:id',
headers: {'content-type': 'application/json'},
body: {
created_at: '',
enabled: false,
id: '',
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
record_type: '',
updated_at: '',
url_shortener_settings: {domain: '', prefix: '', replace_blacklist_only: false, send_webhooks: false},
v1_secret: '',
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: '',
whitelisted_destinations: []
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/messaging_profiles/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
created_at: '',
enabled: false,
id: '',
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
record_type: '',
updated_at: '',
url_shortener_settings: {
domain: '',
prefix: '',
replace_blacklist_only: false,
send_webhooks: false
},
v1_secret: '',
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: '',
whitelisted_destinations: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/messaging_profiles/:id',
headers: {'content-type': 'application/json'},
data: {
created_at: '',
enabled: false,
id: '',
name: '',
number_pool_settings: {
geomatch: false,
long_code_weight: '',
skip_unhealthy: false,
sticky_sender: false,
toll_free_weight: ''
},
record_type: '',
updated_at: '',
url_shortener_settings: {domain: '', prefix: '', replace_blacklist_only: false, send_webhooks: false},
v1_secret: '',
webhook_api_version: '',
webhook_failover_url: '',
webhook_url: '',
whitelisted_destinations: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_profiles/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"created_at":"","enabled":false,"id":"","name":"","number_pool_settings":{"geomatch":false,"long_code_weight":"","skip_unhealthy":false,"sticky_sender":false,"toll_free_weight":""},"record_type":"","updated_at":"","url_shortener_settings":{"domain":"","prefix":"","replace_blacklist_only":false,"send_webhooks":false},"v1_secret":"","webhook_api_version":"","webhook_failover_url":"","webhook_url":"","whitelisted_destinations":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"created_at": @"",
@"enabled": @NO,
@"id": @"",
@"name": @"",
@"number_pool_settings": @{ @"geomatch": @NO, @"long_code_weight": @"", @"skip_unhealthy": @NO, @"sticky_sender": @NO, @"toll_free_weight": @"" },
@"record_type": @"",
@"updated_at": @"",
@"url_shortener_settings": @{ @"domain": @"", @"prefix": @"", @"replace_blacklist_only": @NO, @"send_webhooks": @NO },
@"v1_secret": @"",
@"webhook_api_version": @"",
@"webhook_failover_url": @"",
@"webhook_url": @"",
@"whitelisted_destinations": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_profiles/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_profiles/:id",
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([
'created_at' => '',
'enabled' => null,
'id' => '',
'name' => '',
'number_pool_settings' => [
'geomatch' => null,
'long_code_weight' => '',
'skip_unhealthy' => null,
'sticky_sender' => null,
'toll_free_weight' => ''
],
'record_type' => '',
'updated_at' => '',
'url_shortener_settings' => [
'domain' => '',
'prefix' => '',
'replace_blacklist_only' => null,
'send_webhooks' => null
],
'v1_secret' => '',
'webhook_api_version' => '',
'webhook_failover_url' => '',
'webhook_url' => '',
'whitelisted_destinations' => [
]
]),
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;
}
request('PATCH', '{{baseUrl}}/messaging_profiles/:id', [
'body' => '{
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"record_type": "",
"updated_at": "",
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_profiles/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'created_at' => '',
'enabled' => null,
'id' => '',
'name' => '',
'number_pool_settings' => [
'geomatch' => null,
'long_code_weight' => '',
'skip_unhealthy' => null,
'sticky_sender' => null,
'toll_free_weight' => ''
],
'record_type' => '',
'updated_at' => '',
'url_shortener_settings' => [
'domain' => '',
'prefix' => '',
'replace_blacklist_only' => null,
'send_webhooks' => null
],
'v1_secret' => '',
'webhook_api_version' => '',
'webhook_failover_url' => '',
'webhook_url' => '',
'whitelisted_destinations' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'created_at' => '',
'enabled' => null,
'id' => '',
'name' => '',
'number_pool_settings' => [
'geomatch' => null,
'long_code_weight' => '',
'skip_unhealthy' => null,
'sticky_sender' => null,
'toll_free_weight' => ''
],
'record_type' => '',
'updated_at' => '',
'url_shortener_settings' => [
'domain' => '',
'prefix' => '',
'replace_blacklist_only' => null,
'send_webhooks' => null
],
'v1_secret' => '',
'webhook_api_version' => '',
'webhook_failover_url' => '',
'webhook_url' => '',
'whitelisted_destinations' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/messaging_profiles/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_profiles/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"record_type": "",
"updated_at": "",
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_profiles/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"record_type": "",
"updated_at": "",
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/messaging_profiles/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_profiles/:id"
payload = {
"created_at": "",
"enabled": False,
"id": "",
"name": "",
"number_pool_settings": {
"geomatch": False,
"long_code_weight": "",
"skip_unhealthy": False,
"sticky_sender": False,
"toll_free_weight": ""
},
"record_type": "",
"updated_at": "",
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": False,
"send_webhooks": False
},
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_profiles/:id"
payload <- "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/messaging_profiles/:id') do |req|
req.body = "{\n \"created_at\": \"\",\n \"enabled\": false,\n \"id\": \"\",\n \"name\": \"\",\n \"number_pool_settings\": {\n \"geomatch\": false,\n \"long_code_weight\": \"\",\n \"skip_unhealthy\": false,\n \"sticky_sender\": false,\n \"toll_free_weight\": \"\"\n },\n \"record_type\": \"\",\n \"updated_at\": \"\",\n \"url_shortener_settings\": {\n \"domain\": \"\",\n \"prefix\": \"\",\n \"replace_blacklist_only\": false,\n \"send_webhooks\": false\n },\n \"v1_secret\": \"\",\n \"webhook_api_version\": \"\",\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whitelisted_destinations\": []\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_profiles/:id";
let payload = json!({
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": json!({
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
}),
"record_type": "",
"updated_at": "",
"url_shortener_settings": json!({
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
}),
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/messaging_profiles/:id \
--header 'content-type: application/json' \
--data '{
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"record_type": "",
"updated_at": "",
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
}'
echo '{
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
},
"record_type": "",
"updated_at": "",
"url_shortener_settings": {
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
},
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
}' | \
http PATCH {{baseUrl}}/messaging_profiles/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "created_at": "",\n "enabled": false,\n "id": "",\n "name": "",\n "number_pool_settings": {\n "geomatch": false,\n "long_code_weight": "",\n "skip_unhealthy": false,\n "sticky_sender": false,\n "toll_free_weight": ""\n },\n "record_type": "",\n "updated_at": "",\n "url_shortener_settings": {\n "domain": "",\n "prefix": "",\n "replace_blacklist_only": false,\n "send_webhooks": false\n },\n "v1_secret": "",\n "webhook_api_version": "",\n "webhook_failover_url": "",\n "webhook_url": "",\n "whitelisted_destinations": []\n}' \
--output-document \
- {{baseUrl}}/messaging_profiles/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"created_at": "",
"enabled": false,
"id": "",
"name": "",
"number_pool_settings": [
"geomatch": false,
"long_code_weight": "",
"skip_unhealthy": false,
"sticky_sender": false,
"toll_free_weight": ""
],
"record_type": "",
"updated_at": "",
"url_shortener_settings": [
"domain": "",
"prefix": "",
"replace_blacklist_only": false,
"send_webhooks": false
],
"v1_secret": "",
"webhook_api_version": "",
"webhook_failover_url": "",
"webhook_url": "",
"whitelisted_destinations": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-01-23T18:10:02.574Z",
"enabled": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Profile for Messages",
"number_pool_settings": {
"geomatch": false,
"long_code_weight": 2,
"skip_unhealthy": false,
"sticky_sender": true,
"toll_free_weight": 10
},
"record_type": "messaging_profile",
"updated_at": "2019-01-23T18:10:02.574Z",
"url_shortener_settings": {
"domain": "example.ex",
"prefix": "cmpny",
"replace_blacklist_only": true,
"send_webhooks": false
},
"v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
"webhook_api_version": "2",
"webhook_failover_url": "https://backup.example.com/hooks",
"webhook_url": "https://www.example.com/hooks",
"whitelisted_destinations": [
"US"
]
}
}
GET
List messaging URL domains
{{baseUrl}}/messaging_url_domains
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messaging_url_domains");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messaging_url_domains")
require "http/client"
url = "{{baseUrl}}/messaging_url_domains"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messaging_url_domains"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/messaging_url_domains");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messaging_url_domains"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/messaging_url_domains HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messaging_url_domains")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messaging_url_domains"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/messaging_url_domains")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/messaging_url_domains")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/messaging_url_domains');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/messaging_url_domains'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/messaging_url_domains';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/messaging_url_domains',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messaging_url_domains")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messaging_url_domains',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/messaging_url_domains'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/messaging_url_domains');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/messaging_url_domains'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/messaging_url_domains';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/messaging_url_domains"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/messaging_url_domains" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/messaging_url_domains",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/messaging_url_domains');
echo $response->getBody();
setUrl('{{baseUrl}}/messaging_url_domains');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/messaging_url_domains');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/messaging_url_domains' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messaging_url_domains' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messaging_url_domains")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/messaging_url_domains"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/messaging_url_domains"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messaging_url_domains")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messaging_url_domains') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messaging_url_domains";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/messaging_url_domains
http GET {{baseUrl}}/messaging_url_domains
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messaging_url_domains
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messaging_url_domains")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "464bd54e-a328-4b11-a131-28e6793cb6f2",
"record_type": "messaging_url_domain",
"url_domain": "http://example.com",
"use_case": "test"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List mobile operator networks
{{baseUrl}}/mobile_operator_networks
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/mobile_operator_networks");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/mobile_operator_networks")
require "http/client"
url = "{{baseUrl}}/mobile_operator_networks"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/mobile_operator_networks"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/mobile_operator_networks");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/mobile_operator_networks"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/mobile_operator_networks HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/mobile_operator_networks")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/mobile_operator_networks"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/mobile_operator_networks")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/mobile_operator_networks")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/mobile_operator_networks');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/mobile_operator_networks'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/mobile_operator_networks';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/mobile_operator_networks',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/mobile_operator_networks")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/mobile_operator_networks',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/mobile_operator_networks'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/mobile_operator_networks');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/mobile_operator_networks'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/mobile_operator_networks';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/mobile_operator_networks"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/mobile_operator_networks" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/mobile_operator_networks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/mobile_operator_networks');
echo $response->getBody();
setUrl('{{baseUrl}}/mobile_operator_networks');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/mobile_operator_networks');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/mobile_operator_networks' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/mobile_operator_networks' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/mobile_operator_networks")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/mobile_operator_networks"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/mobile_operator_networks"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/mobile_operator_networks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/mobile_operator_networks') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/mobile_operator_networks";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/mobile_operator_networks
http GET {{baseUrl}}/mobile_operator_networks
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/mobile_operator_networks
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/mobile_operator_networks")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Add a Notification Setting
{{baseUrl}}/notification_settings
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_settings");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/notification_settings")
require "http/client"
url = "{{baseUrl}}/notification_settings"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/notification_settings"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_settings");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_settings"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/notification_settings HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/notification_settings")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_settings"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_settings")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/notification_settings")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/notification_settings');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/notification_settings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_settings';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_settings',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_settings")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_settings',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/notification_settings'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/notification_settings');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/notification_settings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_settings';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_settings"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_settings" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/notification_settings');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_settings');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_settings');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_settings' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_settings' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/notification_settings")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_settings"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_settings"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/notification_settings') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_settings";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/notification_settings
http POST {{baseUrl}}/notification_settings
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/notification_settings
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_settings")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create a notification channel
{{baseUrl}}/notification_channels
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_channels");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/notification_channels")
require "http/client"
url = "{{baseUrl}}/notification_channels"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/notification_channels"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_channels");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_channels"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/notification_channels HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/notification_channels")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_channels"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_channels")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/notification_channels")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/notification_channels');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/notification_channels'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_channels';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_channels',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_channels")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_channels',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/notification_channels'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/notification_channels');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/notification_channels'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_channels';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_channels"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_channels" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_channels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/notification_channels');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_channels');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_channels');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_channels' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_channels' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/notification_channels")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_channels"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_channels"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_channels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/notification_channels') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_channels";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/notification_channels
http POST {{baseUrl}}/notification_channels
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/notification_channels
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_channels")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create a notification profile
{{baseUrl}}/notification_profiles
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_profiles");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/notification_profiles")
require "http/client"
url = "{{baseUrl}}/notification_profiles"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/notification_profiles"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_profiles");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_profiles"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/notification_profiles HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/notification_profiles")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_profiles"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_profiles")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/notification_profiles")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/notification_profiles');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/notification_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_profiles';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_profiles',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_profiles")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_profiles',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/notification_profiles'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/notification_profiles');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/notification_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_profiles';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_profiles"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_profiles" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/notification_profiles');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_profiles');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_profiles');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_profiles' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_profiles' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/notification_profiles")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_profiles"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_profiles"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/notification_profiles') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_profiles";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/notification_profiles
http POST {{baseUrl}}/notification_profiles
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/notification_profiles
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_profiles")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Delete a notification channel
{{baseUrl}}/notification_channels/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_channels/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/notification_channels/:id")
require "http/client"
url = "{{baseUrl}}/notification_channels/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/notification_channels/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_channels/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_channels/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/notification_channels/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/notification_channels/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_channels/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_channels/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/notification_channels/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/notification_channels/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_channels/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_channels/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_channels/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_channels/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_channels/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_channels/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/notification_channels/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_channels/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_channels/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_channels/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_channels/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_channels/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/notification_channels/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_channels/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_channels/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_channels/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_channels/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/notification_channels/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_channels/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_channels/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_channels/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/notification_channels/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_channels/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/notification_channels/:id
http DELETE {{baseUrl}}/notification_channels/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/notification_channels/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_channels/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Delete a notification profile
{{baseUrl}}/notification_profiles/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_profiles/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/notification_profiles/:id")
require "http/client"
url = "{{baseUrl}}/notification_profiles/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/notification_profiles/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_profiles/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_profiles/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/notification_profiles/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/notification_profiles/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_profiles/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_profiles/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/notification_profiles/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/notification_profiles/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_profiles/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_profiles/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_profiles/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_profiles/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_profiles/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/notification_profiles/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_profiles/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_profiles/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_profiles/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/notification_profiles/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_profiles/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_profiles/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_profiles/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_profiles/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/notification_profiles/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_profiles/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_profiles/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/notification_profiles/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_profiles/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/notification_profiles/:id
http DELETE {{baseUrl}}/notification_profiles/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/notification_profiles/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Delete a notification setting
{{baseUrl}}/notification_settings/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_settings/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/notification_settings/:id")
require "http/client"
url = "{{baseUrl}}/notification_settings/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/notification_settings/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_settings/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_settings/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/notification_settings/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/notification_settings/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_settings/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_settings/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/notification_settings/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/notification_settings/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_settings/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_settings/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_settings/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_settings/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_settings/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_settings/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/notification_settings/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/notification_settings/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_settings/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_settings/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_settings/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_settings/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/notification_settings/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_settings/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_settings/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_settings/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_settings/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/notification_settings/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_settings/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_settings/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_settings/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/notification_settings/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_settings/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/notification_settings/:id
http DELETE {{baseUrl}}/notification_settings/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/notification_settings/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_settings/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List all Notifications Events Conditions
{{baseUrl}}/notification_event_conditions
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_event_conditions");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notification_event_conditions")
require "http/client"
url = "{{baseUrl}}/notification_event_conditions"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notification_event_conditions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_event_conditions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_event_conditions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notification_event_conditions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notification_event_conditions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_event_conditions"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_event_conditions")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notification_event_conditions")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/notification_event_conditions');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/notification_event_conditions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_event_conditions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_event_conditions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_event_conditions")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_event_conditions',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/notification_event_conditions'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notification_event_conditions');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/notification_event_conditions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_event_conditions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_event_conditions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_event_conditions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_event_conditions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/notification_event_conditions');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_event_conditions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_event_conditions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_event_conditions' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_event_conditions' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notification_event_conditions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_event_conditions"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_event_conditions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_event_conditions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notification_event_conditions') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_event_conditions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notification_event_conditions
http GET {{baseUrl}}/notification_event_conditions
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notification_event_conditions
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_event_conditions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List all Notifications Events
{{baseUrl}}/notification_events
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_events");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notification_events")
require "http/client"
url = "{{baseUrl}}/notification_events"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notification_events"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_events");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_events"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notification_events HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notification_events")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_events"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_events")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notification_events")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/notification_events');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notification_events'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_events';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_events',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_events")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_events',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/notification_events'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notification_events');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notification_events'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_events';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_events"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_events" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/notification_events');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_events');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_events');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_events' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_events' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notification_events")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_events"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_events"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notification_events') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_events";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notification_events
http GET {{baseUrl}}/notification_events
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notification_events
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_events")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List all Notifications Profiles
{{baseUrl}}/notification_profiles
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_profiles");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notification_profiles")
require "http/client"
url = "{{baseUrl}}/notification_profiles"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notification_profiles"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_profiles");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_profiles"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notification_profiles HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notification_profiles")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_profiles"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_profiles")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notification_profiles")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/notification_profiles');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notification_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_profiles';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_profiles',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_profiles")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_profiles',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/notification_profiles'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notification_profiles');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notification_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_profiles';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_profiles"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_profiles" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/notification_profiles');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_profiles');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_profiles');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_profiles' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_profiles' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notification_profiles")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_profiles"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_profiles"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notification_profiles') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_profiles";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notification_profiles
http GET {{baseUrl}}/notification_profiles
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notification_profiles
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_profiles")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List notification channels
{{baseUrl}}/notification_channels
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_channels");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notification_channels")
require "http/client"
url = "{{baseUrl}}/notification_channels"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notification_channels"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_channels");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_channels"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notification_channels HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notification_channels")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_channels"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_channels")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notification_channels")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/notification_channels');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notification_channels'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_channels';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_channels',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_channels")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_channels',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/notification_channels'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notification_channels');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notification_channels'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_channels';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_channels"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_channels" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_channels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/notification_channels');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_channels');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_channels');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_channels' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_channels' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notification_channels")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_channels"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_channels"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_channels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notification_channels') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_channels";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notification_channels
http GET {{baseUrl}}/notification_channels
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notification_channels
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_channels")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List notification settings
{{baseUrl}}/notification_settings
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_settings");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notification_settings")
require "http/client"
url = "{{baseUrl}}/notification_settings"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notification_settings"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_settings");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_settings"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notification_settings HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notification_settings")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_settings"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_settings")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notification_settings")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/notification_settings');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notification_settings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_settings';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_settings',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_settings")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_settings',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/notification_settings'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notification_settings');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notification_settings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_settings';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_settings"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_settings" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/notification_settings');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_settings');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_settings');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_settings' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_settings' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notification_settings")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_settings"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_settings"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notification_settings') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_settings";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notification_settings
http GET {{baseUrl}}/notification_settings
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notification_settings
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_settings")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a notification channel
{{baseUrl}}/notification_channels/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_channels/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notification_channels/:id")
require "http/client"
url = "{{baseUrl}}/notification_channels/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notification_channels/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_channels/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_channels/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notification_channels/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notification_channels/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_channels/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_channels/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notification_channels/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/notification_channels/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notification_channels/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_channels/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_channels/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_channels/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_channels/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/notification_channels/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notification_channels/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notification_channels/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_channels/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_channels/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_channels/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_channels/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/notification_channels/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_channels/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_channels/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_channels/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_channels/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notification_channels/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_channels/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_channels/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_channels/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notification_channels/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_channels/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notification_channels/:id
http GET {{baseUrl}}/notification_channels/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notification_channels/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_channels/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Retrieve a notification profile
{{baseUrl}}/notification_profiles/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_profiles/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notification_profiles/:id")
require "http/client"
url = "{{baseUrl}}/notification_profiles/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notification_profiles/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_profiles/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_profiles/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notification_profiles/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notification_profiles/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_profiles/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_profiles/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notification_profiles/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/notification_profiles/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notification_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_profiles/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_profiles/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_profiles/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_profiles/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/notification_profiles/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notification_profiles/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notification_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_profiles/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_profiles/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_profiles/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/notification_profiles/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_profiles/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_profiles/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_profiles/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_profiles/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notification_profiles/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_profiles/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_profiles/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notification_profiles/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_profiles/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notification_profiles/:id
http GET {{baseUrl}}/notification_profiles/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notification_profiles/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Retrieve a notification setting
{{baseUrl}}/notification_settings/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_settings/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notification_settings/:id")
require "http/client"
url = "{{baseUrl}}/notification_settings/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notification_settings/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_settings/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_settings/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notification_settings/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notification_settings/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_settings/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_settings/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notification_settings/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/notification_settings/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notification_settings/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_settings/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_settings/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_settings/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_settings/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/notification_settings/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notification_settings/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notification_settings/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_settings/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_settings/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_settings/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_settings/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/notification_settings/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_settings/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_settings/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_settings/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_settings/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notification_settings/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_settings/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_settings/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_settings/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notification_settings/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_settings/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notification_settings/:id
http GET {{baseUrl}}/notification_settings/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notification_settings/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_settings/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PATCH
Update a notification channel
{{baseUrl}}/notification_channels/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_channels/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/notification_channels/:id")
require "http/client"
url = "{{baseUrl}}/notification_channels/:id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/notification_channels/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_channels/:id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_channels/:id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/notification_channels/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/notification_channels/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_channels/:id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_channels/:id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/notification_channels/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/notification_channels/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PATCH', url: '{{baseUrl}}/notification_channels/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_channels/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_channels/:id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_channels/:id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_channels/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'PATCH', url: '{{baseUrl}}/notification_channels/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/notification_channels/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'PATCH', url: '{{baseUrl}}/notification_channels/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_channels/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_channels/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_channels/:id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_channels/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/notification_channels/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_channels/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_channels/:id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_channels/:id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_channels/:id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PATCH", "/baseUrl/notification_channels/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_channels/:id"
response = requests.patch(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_channels/:id"
response <- VERB("PATCH", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_channels/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/notification_channels/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_channels/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/notification_channels/:id
http PATCH {{baseUrl}}/notification_channels/:id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/notification_channels/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_channels/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PATCH
Update a notification profile
{{baseUrl}}/notification_profiles/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notification_profiles/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/notification_profiles/:id")
require "http/client"
url = "{{baseUrl}}/notification_profiles/:id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/notification_profiles/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notification_profiles/:id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notification_profiles/:id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/notification_profiles/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/notification_profiles/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notification_profiles/:id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/notification_profiles/:id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/notification_profiles/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/notification_profiles/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PATCH', url: '{{baseUrl}}/notification_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notification_profiles/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/notification_profiles/:id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notification_profiles/:id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/notification_profiles/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'PATCH', url: '{{baseUrl}}/notification_profiles/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/notification_profiles/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'PATCH', url: '{{baseUrl}}/notification_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notification_profiles/:id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notification_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/notification_profiles/:id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notification_profiles/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/notification_profiles/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/notification_profiles/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notification_profiles/:id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notification_profiles/:id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notification_profiles/:id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PATCH", "/baseUrl/notification_profiles/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notification_profiles/:id"
response = requests.patch(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notification_profiles/:id"
response <- VERB("PATCH", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notification_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/notification_profiles/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notification_profiles/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/notification_profiles/:id
http PATCH {{baseUrl}}/notification_profiles/:id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/notification_profiles/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notification_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Delete a batch of numbers
{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers
BODY json
{
"phone_numbers": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"phone_numbers\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers" {:content-type :json
:form-params {:phone_numbers []}})
require "http/client"
url = "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"phone_numbers\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers"),
Content = new StringContent("{\n \"phone_numbers\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"phone_numbers\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers"
payload := strings.NewReader("{\n \"phone_numbers\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/phone_numbers/jobs/delete_phone_numbers HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 25
{
"phone_numbers": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers")
.setHeader("content-type", "application/json")
.setBody("{\n \"phone_numbers\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"phone_numbers\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"phone_numbers\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers")
.header("content-type", "application/json")
.body("{\n \"phone_numbers\": []\n}")
.asString();
const data = JSON.stringify({
phone_numbers: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers',
headers: {'content-type': 'application/json'},
data: {phone_numbers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_numbers":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "phone_numbers": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"phone_numbers\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/jobs/delete_phone_numbers',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({phone_numbers: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers',
headers: {'content-type': 'application/json'},
body: {phone_numbers: []},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
phone_numbers: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers',
headers: {'content-type': 'application/json'},
data: {phone_numbers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_numbers":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"phone_numbers": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"phone_numbers\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers",
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([
'phone_numbers' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers', [
'body' => '{
"phone_numbers": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'phone_numbers' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'phone_numbers' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_numbers": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_numbers": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"phone_numbers\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/phone_numbers/jobs/delete_phone_numbers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers"
payload = { "phone_numbers": [] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers"
payload <- "{\n \"phone_numbers\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers")
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 \"phone_numbers\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/phone_numbers/jobs/delete_phone_numbers') do |req|
req.body = "{\n \"phone_numbers\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers";
let payload = json!({"phone_numbers": ()});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/phone_numbers/jobs/delete_phone_numbers \
--header 'content-type: application/json' \
--data '{
"phone_numbers": []
}'
echo '{
"phone_numbers": []
}' | \
http POST {{baseUrl}}/phone_numbers/jobs/delete_phone_numbers \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "phone_numbers": []\n}' \
--output-document \
- {{baseUrl}}/phone_numbers/jobs/delete_phone_numbers
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["phone_numbers": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/jobs/delete_phone_numbers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-10-23T18:10:00.000Z",
"etc": "2020-10-30T18:10:00.000Z",
"failed_operations": [
{
"errors": [
{
"code": "10015",
"detail": "The field is invalid.",
"source": "/emergency_address_id",
"title": "Bad Request"
}
],
"id": "3388768018273",
"phone_number": "+19705551234"
}
],
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"pending_operations": [
{
"id": "2637816387126861837",
"phone_number": "+19705555099"
}
],
"record_type": "phone_numbers_job",
"status": "pending",
"successful_operations": [
{
"id": "2637816387126861836",
"phone_number": "+19705555098"
},
{
"id": "33081887126861836",
"phone_number": "+19715555098"
}
],
"type": "update_emergency_settings",
"updated_at": "2020-10-23T18:10:01.000Z"
}
}
GET
Lists the phone numbers jobs
{{baseUrl}}/phone_numbers/jobs
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/jobs");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/jobs")
require "http/client"
url = "{{baseUrl}}/phone_numbers/jobs"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/jobs"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/jobs");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/jobs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/jobs HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/jobs")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/jobs"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/jobs")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/jobs');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/jobs'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/jobs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/jobs',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/jobs',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/jobs'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/jobs');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/jobs'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/jobs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/jobs"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/jobs" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/jobs');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/jobs');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/jobs');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/jobs' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/jobs' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/jobs")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/jobs"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/jobs"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/jobs') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/jobs";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/jobs
http GET {{baseUrl}}/phone_numbers/jobs
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/jobs
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/jobs")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"created_at": "2020-10-23T18:10:00.000Z",
"etc": "2020-10-30T18:10:00.000Z",
"failed_operations": [
{
"errors": [
{
"code": "10015",
"detail": "The field is invalid.",
"source": "/emergency_address_id",
"title": "Bad Request"
}
],
"id": "3388768018273",
"phone_number": "+19705551234"
}
],
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"pending_operations": [
{
"id": "2637816387126861837",
"phone_number": "+19705555099"
}
],
"record_type": "phone_numbers_job",
"status": "pending",
"successful_operations": [
{
"id": "2637816387126861836",
"phone_number": "+19705555098"
},
{
"id": "33081887126861836",
"phone_number": "+19715555098"
}
],
"type": "update_emergency_settings",
"updated_at": "2020-10-23T18:10:01.000Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a phone numbers job
{{baseUrl}}/phone_numbers/jobs/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/jobs/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/jobs/:id")
require "http/client"
url = "{{baseUrl}}/phone_numbers/jobs/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/jobs/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/jobs/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/jobs/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/jobs/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/jobs/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/jobs/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/jobs/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/jobs/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/jobs/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/jobs/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/jobs/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/jobs/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/jobs/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/jobs/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/jobs/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/jobs/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/jobs/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/jobs/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/jobs/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/jobs/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/jobs/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/jobs/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/jobs/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/jobs/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/jobs/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/jobs/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/jobs/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/jobs/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/jobs/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/jobs/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/jobs/:id
http GET {{baseUrl}}/phone_numbers/jobs/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/jobs/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/jobs/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-10-23T18:10:00.000Z",
"etc": "2020-10-30T18:10:00.000Z",
"failed_operations": [
{
"errors": [
{
"code": "10015",
"detail": "The field is invalid.",
"source": "/emergency_address_id",
"title": "Bad Request"
}
],
"id": "3388768018273",
"phone_number": "+19705551234"
}
],
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"pending_operations": [
{
"id": "2637816387126861837",
"phone_number": "+19705555099"
}
],
"record_type": "phone_numbers_job",
"status": "pending",
"successful_operations": [
{
"id": "2637816387126861836",
"phone_number": "+19705555098"
},
{
"id": "33081887126861836",
"phone_number": "+19715555098"
}
],
"type": "update_emergency_settings",
"updated_at": "2020-10-23T18:10:01.000Z"
}
}
POST
Update a batch of numbers
{{baseUrl}}/phone_numbers/jobs/update_phone_numbers
BODY json
{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers" {:content-type :json
:form-params {:billing_group_id ""
:connection_id ""
:customer_reference ""
:external_pin ""
:phone_numbers []
:tags []}})
require "http/client"
url = "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/jobs/update_phone_numbers"),
Content = new StringContent("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/jobs/update_phone_numbers");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers"
payload := strings.NewReader("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/phone_numbers/jobs/update_phone_numbers HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 138
{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers")
.setHeader("content-type", "application/json")
.setBody("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/jobs/update_phone_numbers"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs/update_phone_numbers")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/phone_numbers/jobs/update_phone_numbers")
.header("content-type", "application/json")
.body("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}")
.asString();
const data = JSON.stringify({
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
phone_numbers: [],
tags: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
phone_numbers: [],
tags: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","connection_id":"","customer_reference":"","external_pin":"","phone_numbers":[],"tags":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "billing_group_id": "",\n "connection_id": "",\n "customer_reference": "",\n "external_pin": "",\n "phone_numbers": [],\n "tags": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs/update_phone_numbers")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/jobs/update_phone_numbers',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
phone_numbers: [],
tags: []
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers',
headers: {'content-type': 'application/json'},
body: {
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
phone_numbers: [],
tags: []
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
phone_numbers: [],
tags: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
phone_numbers: [],
tags: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","connection_id":"","customer_reference":"","external_pin":"","phone_numbers":[],"tags":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"billing_group_id": @"",
@"connection_id": @"",
@"customer_reference": @"",
@"external_pin": @"",
@"phone_numbers": @[ ],
@"tags": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/jobs/update_phone_numbers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/jobs/update_phone_numbers",
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([
'billing_group_id' => '',
'connection_id' => '',
'customer_reference' => '',
'external_pin' => '',
'phone_numbers' => [
],
'tags' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers', [
'body' => '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/jobs/update_phone_numbers');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'billing_group_id' => '',
'connection_id' => '',
'customer_reference' => '',
'external_pin' => '',
'phone_numbers' => [
],
'tags' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'billing_group_id' => '',
'connection_id' => '',
'customer_reference' => '',
'external_pin' => '',
'phone_numbers' => [
],
'tags' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/phone_numbers/jobs/update_phone_numbers');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/jobs/update_phone_numbers' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/phone_numbers/jobs/update_phone_numbers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers"
payload = {
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers"
payload <- "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/jobs/update_phone_numbers")
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 \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/phone_numbers/jobs/update_phone_numbers') do |req|
req.body = "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"phone_numbers\": [],\n \"tags\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers";
let payload = json!({
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": (),
"tags": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/phone_numbers/jobs/update_phone_numbers \
--header 'content-type: application/json' \
--data '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
}'
echo '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
}' | \
http POST {{baseUrl}}/phone_numbers/jobs/update_phone_numbers \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "billing_group_id": "",\n "connection_id": "",\n "customer_reference": "",\n "external_pin": "",\n "phone_numbers": [],\n "tags": []\n}' \
--output-document \
- {{baseUrl}}/phone_numbers/jobs/update_phone_numbers
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"phone_numbers": [],
"tags": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/jobs/update_phone_numbers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-10-23T18:10:00.000Z",
"etc": "2020-10-30T18:10:00.000Z",
"failed_operations": [
{
"errors": [
{
"code": "10015",
"detail": "The field is invalid.",
"source": "/emergency_address_id",
"title": "Bad Request"
}
],
"id": "3388768018273",
"phone_number": "+19705551234"
}
],
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"pending_operations": [
{
"id": "2637816387126861837",
"phone_number": "+19705555099"
}
],
"record_type": "phone_numbers_job",
"status": "pending",
"successful_operations": [
{
"id": "2637816387126861836",
"phone_number": "+19705555098"
},
{
"id": "33081887126861836",
"phone_number": "+19715555098"
}
],
"type": "update_emergency_settings",
"updated_at": "2020-10-23T18:10:01.000Z"
}
}
POST
Update the emergency settings from a batch of numbers
{{baseUrl}}/phone_numbers/jobs/update_emergency_settings
BODY json
{
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings" {:content-type :json
:form-params {:emergency_address_id ""
:emergency_enabled false
:phone_numbers []}})
require "http/client"
url = "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/jobs/update_emergency_settings"),
Content = new StringContent("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/jobs/update_emergency_settings");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings"
payload := strings.NewReader("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/phone_numbers/jobs/update_emergency_settings HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 85
{
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings")
.setHeader("content-type", "application/json")
.setBody("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/jobs/update_emergency_settings"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs/update_emergency_settings")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/phone_numbers/jobs/update_emergency_settings")
.header("content-type", "application/json")
.body("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}")
.asString();
const data = JSON.stringify({
emergency_address_id: '',
emergency_enabled: false,
phone_numbers: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings',
headers: {'content-type': 'application/json'},
data: {emergency_address_id: '', emergency_enabled: false, phone_numbers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"emergency_address_id":"","emergency_enabled":false,"phone_numbers":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "emergency_address_id": "",\n "emergency_enabled": false,\n "phone_numbers": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/jobs/update_emergency_settings")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/jobs/update_emergency_settings',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({emergency_address_id: '', emergency_enabled: false, phone_numbers: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings',
headers: {'content-type': 'application/json'},
body: {emergency_address_id: '', emergency_enabled: false, phone_numbers: []},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
emergency_address_id: '',
emergency_enabled: false,
phone_numbers: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings',
headers: {'content-type': 'application/json'},
data: {emergency_address_id: '', emergency_enabled: false, phone_numbers: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"emergency_address_id":"","emergency_enabled":false,"phone_numbers":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"emergency_address_id": @"",
@"emergency_enabled": @NO,
@"phone_numbers": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/jobs/update_emergency_settings"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/jobs/update_emergency_settings",
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([
'emergency_address_id' => '',
'emergency_enabled' => null,
'phone_numbers' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings', [
'body' => '{
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/jobs/update_emergency_settings');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'emergency_address_id' => '',
'emergency_enabled' => null,
'phone_numbers' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'emergency_address_id' => '',
'emergency_enabled' => null,
'phone_numbers' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/phone_numbers/jobs/update_emergency_settings');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/jobs/update_emergency_settings' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/phone_numbers/jobs/update_emergency_settings", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings"
payload = {
"emergency_address_id": "",
"emergency_enabled": False,
"phone_numbers": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings"
payload <- "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/jobs/update_emergency_settings")
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 \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/phone_numbers/jobs/update_emergency_settings') do |req|
req.body = "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false,\n \"phone_numbers\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings";
let payload = json!({
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/phone_numbers/jobs/update_emergency_settings \
--header 'content-type: application/json' \
--data '{
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": []
}'
echo '{
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": []
}' | \
http POST {{baseUrl}}/phone_numbers/jobs/update_emergency_settings \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "emergency_address_id": "",\n "emergency_enabled": false,\n "phone_numbers": []\n}' \
--output-document \
- {{baseUrl}}/phone_numbers/jobs/update_emergency_settings
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"emergency_address_id": "",
"emergency_enabled": false,
"phone_numbers": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/jobs/update_emergency_settings")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-10-23T18:10:00.000Z",
"etc": "2020-10-30T18:10:00.000Z",
"failed_operations": [
{
"errors": [
{
"code": "10015",
"detail": "The field is invalid.",
"source": "/emergency_address_id",
"title": "Bad Request"
}
],
"id": "3388768018273",
"phone_number": "+19705551234"
}
],
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"pending_operations": [
{
"id": "2637816387126861837",
"phone_number": "+19705555099"
}
],
"record_type": "phone_numbers_job",
"status": "pending",
"successful_operations": [
{
"id": "2637816387126861836",
"phone_number": "+19705555098"
},
{
"id": "33081887126861836",
"phone_number": "+19715555098"
}
],
"type": "update_emergency_settings",
"updated_at": "2020-10-23T18:10:01.000Z"
}
}
POST
Create a number block order
{{baseUrl}}/number_block_orders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_block_orders");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/number_block_orders")
require "http/client"
url = "{{baseUrl}}/number_block_orders"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/number_block_orders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_block_orders");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_block_orders"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/number_block_orders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/number_block_orders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_block_orders"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_block_orders")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/number_block_orders")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/number_block_orders');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/number_block_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_block_orders';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_block_orders',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_block_orders")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_block_orders',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/number_block_orders'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/number_block_orders');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/number_block_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_block_orders';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_block_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_block_orders" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_block_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/number_block_orders');
echo $response->getBody();
setUrl('{{baseUrl}}/number_block_orders');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_block_orders');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_block_orders' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_block_orders' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/number_block_orders", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_block_orders"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_block_orders"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_block_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/number_block_orders') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_block_orders";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/number_block_orders
http POST {{baseUrl}}/number_block_orders
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/number_block_orders
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_block_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers_count": 10,
"range": 10,
"record_type": "number_block_order",
"requirements_met": true,
"starting_number": "+19705555000",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
}
GET
List number block orders
{{baseUrl}}/number_block_orders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_block_orders");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_block_orders")
require "http/client"
url = "{{baseUrl}}/number_block_orders"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_block_orders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_block_orders");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_block_orders"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_block_orders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_block_orders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_block_orders"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_block_orders")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_block_orders")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_block_orders');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/number_block_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_block_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_block_orders',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_block_orders")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_block_orders',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/number_block_orders'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_block_orders');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/number_block_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_block_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_block_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_block_orders" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_block_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_block_orders');
echo $response->getBody();
setUrl('{{baseUrl}}/number_block_orders');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_block_orders');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_block_orders' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_block_orders' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_block_orders")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_block_orders"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_block_orders"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_block_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_block_orders') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_block_orders";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_block_orders
http GET {{baseUrl}}/number_block_orders
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_block_orders
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_block_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers_count": 10,
"range": 10,
"record_type": "number_block_order",
"requirements_met": true,
"starting_number": "+19705555000",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a number block order
{{baseUrl}}/number_block_orders/:number_block_order_id
QUERY PARAMS
number_block_order_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_block_orders/:number_block_order_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_block_orders/:number_block_order_id")
require "http/client"
url = "{{baseUrl}}/number_block_orders/:number_block_order_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_block_orders/:number_block_order_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_block_orders/:number_block_order_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_block_orders/:number_block_order_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_block_orders/:number_block_order_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_block_orders/:number_block_order_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_block_orders/:number_block_order_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_block_orders/:number_block_order_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_block_orders/:number_block_order_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_block_orders/:number_block_order_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/number_block_orders/:number_block_order_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_block_orders/:number_block_order_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_block_orders/:number_block_order_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_block_orders/:number_block_order_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_block_orders/:number_block_order_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/number_block_orders/:number_block_order_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_block_orders/:number_block_order_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/number_block_orders/:number_block_order_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_block_orders/:number_block_order_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_block_orders/:number_block_order_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_block_orders/:number_block_order_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_block_orders/:number_block_order_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_block_orders/:number_block_order_id');
echo $response->getBody();
setUrl('{{baseUrl}}/number_block_orders/:number_block_order_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_block_orders/:number_block_order_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_block_orders/:number_block_order_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_block_orders/:number_block_order_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_block_orders/:number_block_order_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_block_orders/:number_block_order_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_block_orders/:number_block_order_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_block_orders/:number_block_order_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_block_orders/:number_block_order_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_block_orders/:number_block_order_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_block_orders/:number_block_order_id
http GET {{baseUrl}}/number_block_orders/:number_block_order_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_block_orders/:number_block_order_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_block_orders/:number_block_order_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers_count": 10,
"range": 10,
"record_type": "number_block_order",
"requirements_met": true,
"starting_number": "+19705555000",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
}
POST
Deletes all numbers associated with a phone number block
{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block
BODY json
{
"phone_number_block_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"phone_number_block_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block" {:content-type :json
:form-params {:phone_number_block_id ""}})
require "http/client"
url = "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"phone_number_block_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block"),
Content = new StringContent("{\n \"phone_number_block_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"phone_number_block_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block"
payload := strings.NewReader("{\n \"phone_number_block_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/phone_number_blocks/jobs/delete_phone_number_block HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 33
{
"phone_number_block_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block")
.setHeader("content-type", "application/json")
.setBody("{\n \"phone_number_block_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"phone_number_block_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"phone_number_block_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block")
.header("content-type", "application/json")
.body("{\n \"phone_number_block_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
phone_number_block_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block',
headers: {'content-type': 'application/json'},
data: {phone_number_block_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_number_block_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "phone_number_block_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"phone_number_block_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_number_blocks/jobs/delete_phone_number_block',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({phone_number_block_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block',
headers: {'content-type': 'application/json'},
body: {phone_number_block_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
phone_number_block_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block',
headers: {'content-type': 'application/json'},
data: {phone_number_block_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_number_block_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"phone_number_block_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"phone_number_block_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block",
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([
'phone_number_block_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block', [
'body' => '{
"phone_number_block_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'phone_number_block_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'phone_number_block_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_number_block_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_number_block_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"phone_number_block_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/phone_number_blocks/jobs/delete_phone_number_block", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block"
payload = { "phone_number_block_id": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block"
payload <- "{\n \"phone_number_block_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block")
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 \"phone_number_block_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/phone_number_blocks/jobs/delete_phone_number_block') do |req|
req.body = "{\n \"phone_number_block_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block";
let payload = json!({"phone_number_block_id": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block \
--header 'content-type: application/json' \
--data '{
"phone_number_block_id": ""
}'
echo '{
"phone_number_block_id": ""
}' | \
http POST {{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "phone_number_block_id": ""\n}' \
--output-document \
- {{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["phone_number_block_id": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_number_blocks/jobs/delete_phone_number_block")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-10-23T18:10:00.000Z",
"etc": "2020-10-30T18:10:00.000Z",
"failed_operations": [],
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "phone_numbers_job",
"status": "pending",
"successful_operations": [],
"type": "delete_phone_number_block",
"updated_at": "2020-10-23T18:10:01.000Z"
}
}
GET
Lists the phone number blocks jobs
{{baseUrl}}/phone_number_blocks/jobs
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_number_blocks/jobs");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_number_blocks/jobs")
require "http/client"
url = "{{baseUrl}}/phone_number_blocks/jobs"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_number_blocks/jobs"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_number_blocks/jobs");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_number_blocks/jobs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_number_blocks/jobs HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_number_blocks/jobs")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_number_blocks/jobs"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_number_blocks/jobs")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_number_blocks/jobs")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_number_blocks/jobs');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_number_blocks/jobs'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_number_blocks/jobs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_number_blocks/jobs',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_number_blocks/jobs")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_number_blocks/jobs',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_number_blocks/jobs'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_number_blocks/jobs');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_number_blocks/jobs'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_number_blocks/jobs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_number_blocks/jobs"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_number_blocks/jobs" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_number_blocks/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_number_blocks/jobs');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_number_blocks/jobs');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_number_blocks/jobs');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_number_blocks/jobs' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_number_blocks/jobs' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_number_blocks/jobs")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_number_blocks/jobs"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_number_blocks/jobs"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_number_blocks/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_number_blocks/jobs') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_number_blocks/jobs";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_number_blocks/jobs
http GET {{baseUrl}}/phone_number_blocks/jobs
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_number_blocks/jobs
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_number_blocks/jobs")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"created_at": "2020-10-23T18:10:00.000Z",
"etc": "2020-10-30T18:10:00.000Z",
"failed_operations": [],
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "phone_numbers_job",
"status": "pending",
"successful_operations": [],
"type": "delete_phone_number_block",
"updated_at": "2020-10-23T18:10:01.000Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieves a phone number blocks job
{{baseUrl}}/phone_number_blocks/jobs/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_number_blocks/jobs/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_number_blocks/jobs/:id")
require "http/client"
url = "{{baseUrl}}/phone_number_blocks/jobs/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_number_blocks/jobs/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_number_blocks/jobs/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_number_blocks/jobs/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_number_blocks/jobs/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_number_blocks/jobs/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_number_blocks/jobs/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_number_blocks/jobs/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_number_blocks/jobs/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_number_blocks/jobs/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_number_blocks/jobs/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_number_blocks/jobs/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_number_blocks/jobs/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_number_blocks/jobs/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_number_blocks/jobs/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_number_blocks/jobs/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_number_blocks/jobs/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_number_blocks/jobs/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_number_blocks/jobs/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_number_blocks/jobs/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_number_blocks/jobs/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_number_blocks/jobs/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_number_blocks/jobs/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_number_blocks/jobs/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_number_blocks/jobs/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_number_blocks/jobs/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_number_blocks/jobs/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_number_blocks/jobs/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_number_blocks/jobs/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_number_blocks/jobs/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_number_blocks/jobs/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_number_blocks/jobs/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_number_blocks/jobs/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_number_blocks/jobs/:id
http GET {{baseUrl}}/phone_number_blocks/jobs/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_number_blocks/jobs/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_number_blocks/jobs/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-10-23T18:10:00.000Z",
"etc": "2020-10-30T18:10:00.000Z",
"failed_operations": [],
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "phone_numbers_job",
"status": "pending",
"successful_operations": [],
"type": "delete_phone_number_block",
"updated_at": "2020-10-23T18:10:01.000Z"
}
}
DELETE
Delete a phone number
{{baseUrl}}/phone_numbers/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/phone_numbers/:id")
require "http/client"
url = "{{baseUrl}}/phone_numbers/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/phone_numbers/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/phone_numbers/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/phone_numbers/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/phone_numbers/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/phone_numbers/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/phone_numbers/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/phone_numbers/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/phone_numbers/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/phone_numbers/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/phone_numbers/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/phone_numbers/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/phone_numbers/:id
http DELETE {{baseUrl}}/phone_numbers/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/phone_numbers/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"call_forwarding_enabled": true,
"call_recording_enabled": true,
"caller_id_name_enabled": true,
"cnam_listing_enabled": true,
"connection_id": "1293384261075731499",
"connection_name": "connection-name",
"created_at": "2019-10-23T18:10:00.000Z",
"customer_reference": "customer-reference",
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true,
"external_pin": "1234",
"id": "1293384261075731499",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
"messaging_profile_name": "regional-customers",
"number_level_routing": "disabled",
"phone_number": "+19705555098",
"phone_number_type": "longcode",
"purchased_at": "2019-10-23T18:10:00.000Z",
"record_type": "phone_number",
"status": "deleted",
"t38_fax_gateway_enabled": true,
"tags": [
"tag_1",
"tag_2"
],
"updated_at": "2019-10-24T18:10:00.000Z"
}
}
POST
Enable emergency for a phone number
{{baseUrl}}/phone_numbers/:id/actions/enable_emergency
QUERY PARAMS
id
BODY json
{
"emergency_address_id": "",
"emergency_enabled": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency" {:content-type :json
:form-params {:emergency_address_id ""
:emergency_enabled false}})
require "http/client"
url = "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/:id/actions/enable_emergency"),
Content = new StringContent("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/:id/actions/enable_emergency");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency"
payload := strings.NewReader("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\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(res)
fmt.Println(string(body))
}
POST /baseUrl/phone_numbers/:id/actions/enable_emergency HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 62
{
"emergency_address_id": "",
"emergency_enabled": false
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency")
.setHeader("content-type", "application/json")
.setBody("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/:id/actions/enable_emergency"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/actions/enable_emergency")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/phone_numbers/:id/actions/enable_emergency")
.header("content-type", "application/json")
.body("{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}")
.asString();
const data = JSON.stringify({
emergency_address_id: '',
emergency_enabled: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency',
headers: {'content-type': 'application/json'},
data: {emergency_address_id: '', emergency_enabled: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"emergency_address_id":"","emergency_enabled":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "emergency_address_id": "",\n "emergency_enabled": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/actions/enable_emergency")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/:id/actions/enable_emergency',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({emergency_address_id: '', emergency_enabled: false}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency',
headers: {'content-type': 'application/json'},
body: {emergency_address_id: '', emergency_enabled: false},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
emergency_address_id: '',
emergency_enabled: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency',
headers: {'content-type': 'application/json'},
data: {emergency_address_id: '', emergency_enabled: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"emergency_address_id":"","emergency_enabled":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"emergency_address_id": @"",
@"emergency_enabled": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/:id/actions/enable_emergency"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/:id/actions/enable_emergency",
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([
'emergency_address_id' => '',
'emergency_enabled' => null
]),
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;
}
request('POST', '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency', [
'body' => '{
"emergency_address_id": "",
"emergency_enabled": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/:id/actions/enable_emergency');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'emergency_address_id' => '',
'emergency_enabled' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'emergency_address_id' => '',
'emergency_enabled' => null
]));
$request->setRequestUrl('{{baseUrl}}/phone_numbers/:id/actions/enable_emergency');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"emergency_address_id": "",
"emergency_enabled": false
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/:id/actions/enable_emergency' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"emergency_address_id": "",
"emergency_enabled": false
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/phone_numbers/:id/actions/enable_emergency", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency"
payload = {
"emergency_address_id": "",
"emergency_enabled": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency"
payload <- "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/:id/actions/enable_emergency")
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 \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/phone_numbers/:id/actions/enable_emergency') do |req|
req.body = "{\n \"emergency_address_id\": \"\",\n \"emergency_enabled\": false\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency";
let payload = json!({
"emergency_address_id": "",
"emergency_enabled": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/phone_numbers/:id/actions/enable_emergency \
--header 'content-type: application/json' \
--data '{
"emergency_address_id": "",
"emergency_enabled": false
}'
echo '{
"emergency_address_id": "",
"emergency_enabled": false
}' | \
http POST {{baseUrl}}/phone_numbers/:id/actions/enable_emergency \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "emergency_address_id": "",\n "emergency_enabled": false\n}' \
--output-document \
- {{baseUrl}}/phone_numbers/:id/actions/enable_emergency
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"emergency_address_id": "",
"emergency_enabled": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/:id/actions/enable_emergency")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_forwarding": {
"call_forwarding_enabled": true,
"forwarding_type": "always",
"forwards_to": "+13035559123"
},
"call_recording": {
"inbound_call_recording_channels": "single",
"inbound_call_recording_enabled": true,
"inbound_call_recording_format": "wav"
},
"cnam_listing": {
"cnam_listing_details": "example",
"cnam_listing_enabled": true
},
"connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b",
"customer_reference": "customer-reference",
"emergency": {
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true
},
"id": "1293384261075731499",
"media_features": {
"accept_any_rtp_packets_enabled": true,
"media_handling_mode": "default",
"rtp_auto_adjust_enabled": true,
"t38_fax_gateway_enabled": true
},
"record_type": "voice_settings",
"tech_prefix_enabled": false,
"translated_number": "+13035559999",
"usage_payment_method": "pay-per-minute"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_forwarding": {
"call_forwarding_enabled": true,
"forwarding_type": "always",
"forwards_to": "+13035559123"
},
"call_recording": {
"inbound_call_recording_channels": "single",
"inbound_call_recording_enabled": true,
"inbound_call_recording_format": "wav"
},
"cnam_listing": {
"cnam_listing_details": "example",
"cnam_listing_enabled": true
},
"connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b",
"customer_reference": "customer-reference",
"emergency": {
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true
},
"id": "1293384261075731499",
"media_features": {
"accept_any_rtp_packets_enabled": true,
"media_handling_mode": "default",
"rtp_auto_adjust_enabled": true,
"t38_fax_gateway_enabled": true
},
"record_type": "voice_settings",
"tech_prefix_enabled": false,
"translated_number": "+13035559999",
"usage_payment_method": "pay-per-minute"
}
}
GET
List phone numbers with messaging settings
{{baseUrl}}/phone_numbers/messaging
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/messaging");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/messaging")
require "http/client"
url = "{{baseUrl}}/phone_numbers/messaging"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/messaging"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/messaging");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/messaging"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/messaging HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/messaging")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/messaging"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/messaging")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/messaging")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/messaging');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/messaging'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/messaging';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/messaging',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/messaging")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/messaging',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/messaging'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/messaging');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/messaging'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/messaging';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/messaging"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/messaging" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/messaging",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/messaging');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/messaging');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/messaging');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/messaging' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/messaging' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/messaging")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/messaging"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/messaging"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/messaging")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/messaging') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/messaging";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/messaging
http GET {{baseUrl}}/phone_numbers/messaging
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/messaging
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/messaging")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"eligible_messaging_products": [
"A2P"
],
"features": {
"mms": null,
"sms": {
"domestic_two_way": true,
"international_inbound": true,
"international_outbound": true
}
},
"health": {
"inbound_outbound_ratio": 0.43,
"message_count": 122,
"spam_ratio": 0.06,
"success_ratio": 0.94
},
"id": "1293384261075731499",
"messaging_product": "A2P",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"phone_number": "+18005550001",
"record_type": "messaging_settings",
"traffic_type": "A2P",
"type": "toll-free",
"updated_at": "2019-01-23T18:10:02.574Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List phone numbers with voice settings
{{baseUrl}}/phone_numbers/voice
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/voice");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/voice")
require "http/client"
url = "{{baseUrl}}/phone_numbers/voice"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/voice"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/voice");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/voice"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/voice HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/voice")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/voice"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/voice")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/voice")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/voice');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/voice'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/voice';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/voice',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/voice")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/voice',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/voice'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/voice');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/voice'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/voice';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/voice"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/voice" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/voice",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/voice');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/voice');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/voice');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/voice' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/voice' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/voice")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/voice"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/voice"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/voice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/voice') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/voice";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/voice
http GET {{baseUrl}}/phone_numbers/voice
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/voice
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/voice")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"call_forwarding": {
"call_forwarding_enabled": true,
"forwarding_type": "always",
"forwards_to": "+13035559123"
},
"call_recording": {
"inbound_call_recording_channels": "single",
"inbound_call_recording_enabled": true,
"inbound_call_recording_format": "wav"
},
"cnam_listing": {
"cnam_listing_details": "example",
"cnam_listing_enabled": true
},
"connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b",
"customer_reference": "customer-reference",
"emergency": {
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true
},
"id": "1293384261075731499",
"media_features": {
"accept_any_rtp_packets_enabled": true,
"media_handling_mode": "default",
"rtp_auto_adjust_enabled": true,
"t38_fax_gateway_enabled": true
},
"record_type": "voice_settings",
"tech_prefix_enabled": false,
"translated_number": "+13035559999",
"usage_payment_method": "pay-per-minute"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List phone numbers
{{baseUrl}}/phone_numbers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers")
require "http/client"
url = "{{baseUrl}}/phone_numbers"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers
http GET {{baseUrl}}/phone_numbers
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"call_forwarding_enabled": true,
"call_recording_enabled": true,
"caller_id_name_enabled": true,
"cnam_listing_enabled": true,
"connection_id": "1293384261075731499",
"connection_name": "connection-name",
"created_at": "2019-10-23T18:10:00.000Z",
"customer_reference": "customer-reference",
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true,
"external_pin": "1234",
"id": "1293384261075731499",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
"messaging_profile_name": "regional-customers",
"number_level_routing": "disabled",
"phone_number": "+19705555098",
"phone_number_type": "longcode",
"purchased_at": "2019-10-23T18:10:00.000Z",
"record_type": "phone_number",
"status": "active",
"t38_fax_gateway_enabled": true,
"tags": [
"tag_1",
"tag_2"
],
"updated_at": "2019-10-24T18:10:00.000Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a phone number with messaging settings
{{baseUrl}}/phone_numbers/:id/messaging
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/:id/messaging");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/:id/messaging")
require "http/client"
url = "{{baseUrl}}/phone_numbers/:id/messaging"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/:id/messaging"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/:id/messaging");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/:id/messaging"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/:id/messaging HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/:id/messaging")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/:id/messaging"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/messaging")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/:id/messaging")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/:id/messaging');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id/messaging'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/:id/messaging';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/:id/messaging',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/messaging")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/:id/messaging',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id/messaging'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/:id/messaging');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id/messaging'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/:id/messaging';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/:id/messaging"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/:id/messaging" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/:id/messaging",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/:id/messaging');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/:id/messaging');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/:id/messaging');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/:id/messaging' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/:id/messaging' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/:id/messaging")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/:id/messaging"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/:id/messaging"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/:id/messaging")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/:id/messaging') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/:id/messaging";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/:id/messaging
http GET {{baseUrl}}/phone_numbers/:id/messaging
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/:id/messaging
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/:id/messaging")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"eligible_messaging_products": [
"A2P"
],
"features": {
"mms": null,
"sms": {
"domestic_two_way": true,
"international_inbound": true,
"international_outbound": true
}
},
"health": {
"inbound_outbound_ratio": 0.43,
"message_count": 122,
"spam_ratio": 0.06,
"success_ratio": 0.94
},
"id": "1293384261075731499",
"messaging_product": "A2P",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"phone_number": "+18005550001",
"record_type": "messaging_settings",
"traffic_type": "A2P",
"type": "toll-free",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
GET
Retrieve a phone number with voice settings
{{baseUrl}}/phone_numbers/:id/voice
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/:id/voice");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/:id/voice")
require "http/client"
url = "{{baseUrl}}/phone_numbers/:id/voice"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/:id/voice"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/:id/voice");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/:id/voice"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/:id/voice HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/:id/voice")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/:id/voice"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/voice")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/:id/voice")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/:id/voice');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id/voice'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/:id/voice';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/:id/voice',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/voice")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/:id/voice',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id/voice'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/:id/voice');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id/voice'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/:id/voice';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/:id/voice"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/:id/voice" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/:id/voice",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/:id/voice');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/:id/voice');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/:id/voice');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/:id/voice' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/:id/voice' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/:id/voice")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/:id/voice"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/:id/voice"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/:id/voice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/:id/voice') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/:id/voice";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/:id/voice
http GET {{baseUrl}}/phone_numbers/:id/voice
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/:id/voice
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/:id/voice")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_forwarding": {
"call_forwarding_enabled": true,
"forwarding_type": "always",
"forwards_to": "+13035559123"
},
"call_recording": {
"inbound_call_recording_channels": "single",
"inbound_call_recording_enabled": true,
"inbound_call_recording_format": "wav"
},
"cnam_listing": {
"cnam_listing_details": "example",
"cnam_listing_enabled": true
},
"connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b",
"customer_reference": "customer-reference",
"emergency": {
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true
},
"id": "1293384261075731499",
"media_features": {
"accept_any_rtp_packets_enabled": true,
"media_handling_mode": "default",
"rtp_auto_adjust_enabled": true,
"t38_fax_gateway_enabled": true
},
"record_type": "voice_settings",
"tech_prefix_enabled": false,
"translated_number": "+13035559999",
"usage_payment_method": "pay-per-minute"
}
}
GET
Retrieve a phone number
{{baseUrl}}/phone_numbers/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/phone_numbers/:id")
require "http/client"
url = "{{baseUrl}}/phone_numbers/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/phone_numbers/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/phone_numbers/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/phone_numbers/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/phone_numbers/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/phone_numbers/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/phone_numbers/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/phone_numbers/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/phone_numbers/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/phone_numbers/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/phone_numbers/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/phone_numbers/:id
http GET {{baseUrl}}/phone_numbers/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/phone_numbers/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"call_forwarding_enabled": true,
"call_recording_enabled": true,
"caller_id_name_enabled": true,
"cnam_listing_enabled": true,
"connection_id": "1293384261075731499",
"connection_name": "connection-name",
"created_at": "2019-10-23T18:10:00.000Z",
"customer_reference": "customer-reference",
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true,
"external_pin": "1234",
"id": "1293384261075731499",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
"messaging_profile_name": "regional-customers",
"number_level_routing": "disabled",
"phone_number": "+19705555098",
"phone_number_type": "longcode",
"purchased_at": "2019-10-23T18:10:00.000Z",
"record_type": "phone_number",
"status": "active",
"t38_fax_gateway_enabled": true,
"tags": [
"tag_1",
"tag_2"
],
"updated_at": "2019-10-24T18:10:00.000Z"
}
}
PATCH
Update a phone number with messaging settings
{{baseUrl}}/phone_numbers/:id/messaging
QUERY PARAMS
id
BODY json
{
"messaging_product": "",
"messaging_profile_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/:id/messaging");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/phone_numbers/:id/messaging" {:content-type :json
:form-params {:messaging_product ""
:messaging_profile_id ""}})
require "http/client"
url = "{{baseUrl}}/phone_numbers/:id/messaging"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/:id/messaging"),
Content = new StringContent("{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/:id/messaging");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/:id/messaging"
payload := strings.NewReader("{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/phone_numbers/:id/messaging HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 59
{
"messaging_product": "",
"messaging_profile_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/phone_numbers/:id/messaging")
.setHeader("content-type", "application/json")
.setBody("{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/:id/messaging"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/messaging")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/phone_numbers/:id/messaging")
.header("content-type", "application/json")
.body("{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
messaging_product: '',
messaging_profile_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/phone_numbers/:id/messaging');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id/messaging',
headers: {'content-type': 'application/json'},
data: {messaging_product: '', messaging_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/:id/messaging';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"messaging_product":"","messaging_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/:id/messaging',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "messaging_product": "",\n "messaging_profile_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/messaging")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/:id/messaging',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({messaging_product: '', messaging_profile_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id/messaging',
headers: {'content-type': 'application/json'},
body: {messaging_product: '', messaging_profile_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/phone_numbers/:id/messaging');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
messaging_product: '',
messaging_profile_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id/messaging',
headers: {'content-type': 'application/json'},
data: {messaging_product: '', messaging_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/:id/messaging';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"messaging_product":"","messaging_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"messaging_product": @"",
@"messaging_profile_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/:id/messaging"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/:id/messaging" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/:id/messaging",
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([
'messaging_product' => '',
'messaging_profile_id' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/phone_numbers/:id/messaging', [
'body' => '{
"messaging_product": "",
"messaging_profile_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/:id/messaging');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'messaging_product' => '',
'messaging_profile_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'messaging_product' => '',
'messaging_profile_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/phone_numbers/:id/messaging');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/:id/messaging' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"messaging_product": "",
"messaging_profile_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/:id/messaging' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"messaging_product": "",
"messaging_profile_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/phone_numbers/:id/messaging", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/:id/messaging"
payload = {
"messaging_product": "",
"messaging_profile_id": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/:id/messaging"
payload <- "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/:id/messaging")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/phone_numbers/:id/messaging') do |req|
req.body = "{\n \"messaging_product\": \"\",\n \"messaging_profile_id\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/:id/messaging";
let payload = json!({
"messaging_product": "",
"messaging_profile_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/phone_numbers/:id/messaging \
--header 'content-type: application/json' \
--data '{
"messaging_product": "",
"messaging_profile_id": ""
}'
echo '{
"messaging_product": "",
"messaging_profile_id": ""
}' | \
http PATCH {{baseUrl}}/phone_numbers/:id/messaging \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "messaging_product": "",\n "messaging_profile_id": ""\n}' \
--output-document \
- {{baseUrl}}/phone_numbers/:id/messaging
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"messaging_product": "",
"messaging_profile_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/:id/messaging")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"eligible_messaging_products": [
"A2P"
],
"features": {
"mms": null,
"sms": {
"domestic_two_way": true,
"international_inbound": true,
"international_outbound": true
}
},
"health": {
"inbound_outbound_ratio": 0.43,
"message_count": 122,
"spam_ratio": 0.06,
"success_ratio": 0.94
},
"id": "1293384261075731499",
"messaging_product": "A2P",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"phone_number": "+18005550001",
"record_type": "messaging_settings",
"traffic_type": "A2P",
"type": "toll-free",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
PATCH
Update a phone number with voice settings
{{baseUrl}}/phone_numbers/:id/voice
QUERY PARAMS
id
BODY json
{
"call_forwarding": {
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
},
"call_recording": {
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
},
"cnam_listing": {
"cnam_listing_details": "",
"cnam_listing_enabled": false
},
"media_features": {
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
},
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/:id/voice");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/phone_numbers/:id/voice" {:content-type :json
:form-params {:call_forwarding {:call_forwarding_enabled false
:forwarding_type ""
:forwards_to ""}
:call_recording {:inbound_call_recording_channels ""
:inbound_call_recording_enabled false
:inbound_call_recording_format ""}
:cnam_listing {:cnam_listing_details ""
:cnam_listing_enabled false}
:media_features {:accept_any_rtp_packets_enabled false
:media_handling_mode ""
:rtp_auto_adjust_enabled false
:t38_fax_gateway_enabled false}
:tech_prefix_enabled false
:translated_number ""
:usage_payment_method ""}})
require "http/client"
url = "{{baseUrl}}/phone_numbers/:id/voice"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/:id/voice"),
Content = new StringContent("{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/:id/voice");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/:id/voice"
payload := strings.NewReader("{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/phone_numbers/:id/voice HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 630
{
"call_forwarding": {
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
},
"call_recording": {
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
},
"cnam_listing": {
"cnam_listing_details": "",
"cnam_listing_enabled": false
},
"media_features": {
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
},
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/phone_numbers/:id/voice")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/:id/voice"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/voice")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/phone_numbers/:id/voice")
.header("content-type", "application/json")
.body("{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}")
.asString();
const data = JSON.stringify({
call_forwarding: {
call_forwarding_enabled: false,
forwarding_type: '',
forwards_to: ''
},
call_recording: {
inbound_call_recording_channels: '',
inbound_call_recording_enabled: false,
inbound_call_recording_format: ''
},
cnam_listing: {
cnam_listing_details: '',
cnam_listing_enabled: false
},
media_features: {
accept_any_rtp_packets_enabled: false,
media_handling_mode: '',
rtp_auto_adjust_enabled: false,
t38_fax_gateway_enabled: false
},
tech_prefix_enabled: false,
translated_number: '',
usage_payment_method: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/phone_numbers/:id/voice');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id/voice',
headers: {'content-type': 'application/json'},
data: {
call_forwarding: {call_forwarding_enabled: false, forwarding_type: '', forwards_to: ''},
call_recording: {
inbound_call_recording_channels: '',
inbound_call_recording_enabled: false,
inbound_call_recording_format: ''
},
cnam_listing: {cnam_listing_details: '', cnam_listing_enabled: false},
media_features: {
accept_any_rtp_packets_enabled: false,
media_handling_mode: '',
rtp_auto_adjust_enabled: false,
t38_fax_gateway_enabled: false
},
tech_prefix_enabled: false,
translated_number: '',
usage_payment_method: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/:id/voice';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"call_forwarding":{"call_forwarding_enabled":false,"forwarding_type":"","forwards_to":""},"call_recording":{"inbound_call_recording_channels":"","inbound_call_recording_enabled":false,"inbound_call_recording_format":""},"cnam_listing":{"cnam_listing_details":"","cnam_listing_enabled":false},"media_features":{"accept_any_rtp_packets_enabled":false,"media_handling_mode":"","rtp_auto_adjust_enabled":false,"t38_fax_gateway_enabled":false},"tech_prefix_enabled":false,"translated_number":"","usage_payment_method":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/:id/voice',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_forwarding": {\n "call_forwarding_enabled": false,\n "forwarding_type": "",\n "forwards_to": ""\n },\n "call_recording": {\n "inbound_call_recording_channels": "",\n "inbound_call_recording_enabled": false,\n "inbound_call_recording_format": ""\n },\n "cnam_listing": {\n "cnam_listing_details": "",\n "cnam_listing_enabled": false\n },\n "media_features": {\n "accept_any_rtp_packets_enabled": false,\n "media_handling_mode": "",\n "rtp_auto_adjust_enabled": false,\n "t38_fax_gateway_enabled": false\n },\n "tech_prefix_enabled": false,\n "translated_number": "",\n "usage_payment_method": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id/voice")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/:id/voice',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
call_forwarding: {call_forwarding_enabled: false, forwarding_type: '', forwards_to: ''},
call_recording: {
inbound_call_recording_channels: '',
inbound_call_recording_enabled: false,
inbound_call_recording_format: ''
},
cnam_listing: {cnam_listing_details: '', cnam_listing_enabled: false},
media_features: {
accept_any_rtp_packets_enabled: false,
media_handling_mode: '',
rtp_auto_adjust_enabled: false,
t38_fax_gateway_enabled: false
},
tech_prefix_enabled: false,
translated_number: '',
usage_payment_method: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id/voice',
headers: {'content-type': 'application/json'},
body: {
call_forwarding: {call_forwarding_enabled: false, forwarding_type: '', forwards_to: ''},
call_recording: {
inbound_call_recording_channels: '',
inbound_call_recording_enabled: false,
inbound_call_recording_format: ''
},
cnam_listing: {cnam_listing_details: '', cnam_listing_enabled: false},
media_features: {
accept_any_rtp_packets_enabled: false,
media_handling_mode: '',
rtp_auto_adjust_enabled: false,
t38_fax_gateway_enabled: false
},
tech_prefix_enabled: false,
translated_number: '',
usage_payment_method: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/phone_numbers/:id/voice');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_forwarding: {
call_forwarding_enabled: false,
forwarding_type: '',
forwards_to: ''
},
call_recording: {
inbound_call_recording_channels: '',
inbound_call_recording_enabled: false,
inbound_call_recording_format: ''
},
cnam_listing: {
cnam_listing_details: '',
cnam_listing_enabled: false
},
media_features: {
accept_any_rtp_packets_enabled: false,
media_handling_mode: '',
rtp_auto_adjust_enabled: false,
t38_fax_gateway_enabled: false
},
tech_prefix_enabled: false,
translated_number: '',
usage_payment_method: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id/voice',
headers: {'content-type': 'application/json'},
data: {
call_forwarding: {call_forwarding_enabled: false, forwarding_type: '', forwards_to: ''},
call_recording: {
inbound_call_recording_channels: '',
inbound_call_recording_enabled: false,
inbound_call_recording_format: ''
},
cnam_listing: {cnam_listing_details: '', cnam_listing_enabled: false},
media_features: {
accept_any_rtp_packets_enabled: false,
media_handling_mode: '',
rtp_auto_adjust_enabled: false,
t38_fax_gateway_enabled: false
},
tech_prefix_enabled: false,
translated_number: '',
usage_payment_method: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/:id/voice';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"call_forwarding":{"call_forwarding_enabled":false,"forwarding_type":"","forwards_to":""},"call_recording":{"inbound_call_recording_channels":"","inbound_call_recording_enabled":false,"inbound_call_recording_format":""},"cnam_listing":{"cnam_listing_details":"","cnam_listing_enabled":false},"media_features":{"accept_any_rtp_packets_enabled":false,"media_handling_mode":"","rtp_auto_adjust_enabled":false,"t38_fax_gateway_enabled":false},"tech_prefix_enabled":false,"translated_number":"","usage_payment_method":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_forwarding": @{ @"call_forwarding_enabled": @NO, @"forwarding_type": @"", @"forwards_to": @"" },
@"call_recording": @{ @"inbound_call_recording_channels": @"", @"inbound_call_recording_enabled": @NO, @"inbound_call_recording_format": @"" },
@"cnam_listing": @{ @"cnam_listing_details": @"", @"cnam_listing_enabled": @NO },
@"media_features": @{ @"accept_any_rtp_packets_enabled": @NO, @"media_handling_mode": @"", @"rtp_auto_adjust_enabled": @NO, @"t38_fax_gateway_enabled": @NO },
@"tech_prefix_enabled": @NO,
@"translated_number": @"",
@"usage_payment_method": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/:id/voice"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/:id/voice" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/:id/voice",
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([
'call_forwarding' => [
'call_forwarding_enabled' => null,
'forwarding_type' => '',
'forwards_to' => ''
],
'call_recording' => [
'inbound_call_recording_channels' => '',
'inbound_call_recording_enabled' => null,
'inbound_call_recording_format' => ''
],
'cnam_listing' => [
'cnam_listing_details' => '',
'cnam_listing_enabled' => null
],
'media_features' => [
'accept_any_rtp_packets_enabled' => null,
'media_handling_mode' => '',
'rtp_auto_adjust_enabled' => null,
't38_fax_gateway_enabled' => null
],
'tech_prefix_enabled' => null,
'translated_number' => '',
'usage_payment_method' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/phone_numbers/:id/voice', [
'body' => '{
"call_forwarding": {
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
},
"call_recording": {
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
},
"cnam_listing": {
"cnam_listing_details": "",
"cnam_listing_enabled": false
},
"media_features": {
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
},
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/:id/voice');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_forwarding' => [
'call_forwarding_enabled' => null,
'forwarding_type' => '',
'forwards_to' => ''
],
'call_recording' => [
'inbound_call_recording_channels' => '',
'inbound_call_recording_enabled' => null,
'inbound_call_recording_format' => ''
],
'cnam_listing' => [
'cnam_listing_details' => '',
'cnam_listing_enabled' => null
],
'media_features' => [
'accept_any_rtp_packets_enabled' => null,
'media_handling_mode' => '',
'rtp_auto_adjust_enabled' => null,
't38_fax_gateway_enabled' => null
],
'tech_prefix_enabled' => null,
'translated_number' => '',
'usage_payment_method' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_forwarding' => [
'call_forwarding_enabled' => null,
'forwarding_type' => '',
'forwards_to' => ''
],
'call_recording' => [
'inbound_call_recording_channels' => '',
'inbound_call_recording_enabled' => null,
'inbound_call_recording_format' => ''
],
'cnam_listing' => [
'cnam_listing_details' => '',
'cnam_listing_enabled' => null
],
'media_features' => [
'accept_any_rtp_packets_enabled' => null,
'media_handling_mode' => '',
'rtp_auto_adjust_enabled' => null,
't38_fax_gateway_enabled' => null
],
'tech_prefix_enabled' => null,
'translated_number' => '',
'usage_payment_method' => ''
]));
$request->setRequestUrl('{{baseUrl}}/phone_numbers/:id/voice');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/:id/voice' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"call_forwarding": {
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
},
"call_recording": {
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
},
"cnam_listing": {
"cnam_listing_details": "",
"cnam_listing_enabled": false
},
"media_features": {
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
},
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/:id/voice' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"call_forwarding": {
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
},
"call_recording": {
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
},
"cnam_listing": {
"cnam_listing_details": "",
"cnam_listing_enabled": false
},
"media_features": {
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
},
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/phone_numbers/:id/voice", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/:id/voice"
payload = {
"call_forwarding": {
"call_forwarding_enabled": False,
"forwarding_type": "",
"forwards_to": ""
},
"call_recording": {
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": False,
"inbound_call_recording_format": ""
},
"cnam_listing": {
"cnam_listing_details": "",
"cnam_listing_enabled": False
},
"media_features": {
"accept_any_rtp_packets_enabled": False,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": False,
"t38_fax_gateway_enabled": False
},
"tech_prefix_enabled": False,
"translated_number": "",
"usage_payment_method": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/:id/voice"
payload <- "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/:id/voice")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/phone_numbers/:id/voice') do |req|
req.body = "{\n \"call_forwarding\": {\n \"call_forwarding_enabled\": false,\n \"forwarding_type\": \"\",\n \"forwards_to\": \"\"\n },\n \"call_recording\": {\n \"inbound_call_recording_channels\": \"\",\n \"inbound_call_recording_enabled\": false,\n \"inbound_call_recording_format\": \"\"\n },\n \"cnam_listing\": {\n \"cnam_listing_details\": \"\",\n \"cnam_listing_enabled\": false\n },\n \"media_features\": {\n \"accept_any_rtp_packets_enabled\": false,\n \"media_handling_mode\": \"\",\n \"rtp_auto_adjust_enabled\": false,\n \"t38_fax_gateway_enabled\": false\n },\n \"tech_prefix_enabled\": false,\n \"translated_number\": \"\",\n \"usage_payment_method\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/:id/voice";
let payload = json!({
"call_forwarding": json!({
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
}),
"call_recording": json!({
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
}),
"cnam_listing": json!({
"cnam_listing_details": "",
"cnam_listing_enabled": false
}),
"media_features": json!({
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
}),
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/phone_numbers/:id/voice \
--header 'content-type: application/json' \
--data '{
"call_forwarding": {
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
},
"call_recording": {
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
},
"cnam_listing": {
"cnam_listing_details": "",
"cnam_listing_enabled": false
},
"media_features": {
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
},
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
}'
echo '{
"call_forwarding": {
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
},
"call_recording": {
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
},
"cnam_listing": {
"cnam_listing_details": "",
"cnam_listing_enabled": false
},
"media_features": {
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
},
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
}' | \
http PATCH {{baseUrl}}/phone_numbers/:id/voice \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "call_forwarding": {\n "call_forwarding_enabled": false,\n "forwarding_type": "",\n "forwards_to": ""\n },\n "call_recording": {\n "inbound_call_recording_channels": "",\n "inbound_call_recording_enabled": false,\n "inbound_call_recording_format": ""\n },\n "cnam_listing": {\n "cnam_listing_details": "",\n "cnam_listing_enabled": false\n },\n "media_features": {\n "accept_any_rtp_packets_enabled": false,\n "media_handling_mode": "",\n "rtp_auto_adjust_enabled": false,\n "t38_fax_gateway_enabled": false\n },\n "tech_prefix_enabled": false,\n "translated_number": "",\n "usage_payment_method": ""\n}' \
--output-document \
- {{baseUrl}}/phone_numbers/:id/voice
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"call_forwarding": [
"call_forwarding_enabled": false,
"forwarding_type": "",
"forwards_to": ""
],
"call_recording": [
"inbound_call_recording_channels": "",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": ""
],
"cnam_listing": [
"cnam_listing_details": "",
"cnam_listing_enabled": false
],
"media_features": [
"accept_any_rtp_packets_enabled": false,
"media_handling_mode": "",
"rtp_auto_adjust_enabled": false,
"t38_fax_gateway_enabled": false
],
"tech_prefix_enabled": false,
"translated_number": "",
"usage_payment_method": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/:id/voice")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_forwarding": {
"call_forwarding_enabled": true,
"forwarding_type": "always",
"forwards_to": "+13035559123"
},
"call_recording": {
"inbound_call_recording_channels": "single",
"inbound_call_recording_enabled": true,
"inbound_call_recording_format": "wav"
},
"cnam_listing": {
"cnam_listing_details": "example",
"cnam_listing_enabled": true
},
"connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b",
"customer_reference": "customer-reference",
"emergency": {
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true
},
"id": "1293384261075731499",
"media_features": {
"accept_any_rtp_packets_enabled": true,
"media_handling_mode": "default",
"rtp_auto_adjust_enabled": true,
"t38_fax_gateway_enabled": true
},
"record_type": "voice_settings",
"tech_prefix_enabled": false,
"translated_number": "+13035559999",
"usage_payment_method": "pay-per-minute"
}
}
PATCH
Update a phone number
{{baseUrl}}/phone_numbers/:id
QUERY PARAMS
id
BODY json
{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/phone_numbers/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/phone_numbers/:id" {:content-type :json
:form-params {:billing_group_id ""
:connection_id ""
:customer_reference ""
:external_pin ""
:id ""
:number_level_routing ""
:tags []}})
require "http/client"
url = "{{baseUrl}}/phone_numbers/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/phone_numbers/:id"),
Content = new StringContent("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/phone_numbers/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/phone_numbers/:id"
payload := strings.NewReader("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/phone_numbers/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 157
{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/phone_numbers/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/phone_numbers/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/phone_numbers/:id")
.header("content-type", "application/json")
.body("{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}")
.asString();
const data = JSON.stringify({
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
id: '',
number_level_routing: '',
tags: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/phone_numbers/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
id: '',
number_level_routing: '',
tags: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/phone_numbers/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","connection_id":"","customer_reference":"","external_pin":"","id":"","number_level_routing":"","tags":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/phone_numbers/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "billing_group_id": "",\n "connection_id": "",\n "customer_reference": "",\n "external_pin": "",\n "id": "",\n "number_level_routing": "",\n "tags": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/phone_numbers/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/phone_numbers/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
id: '',
number_level_routing: '',
tags: []
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id',
headers: {'content-type': 'application/json'},
body: {
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
id: '',
number_level_routing: '',
tags: []
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/phone_numbers/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
id: '',
number_level_routing: '',
tags: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/phone_numbers/:id',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
connection_id: '',
customer_reference: '',
external_pin: '',
id: '',
number_level_routing: '',
tags: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/phone_numbers/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","connection_id":"","customer_reference":"","external_pin":"","id":"","number_level_routing":"","tags":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"billing_group_id": @"",
@"connection_id": @"",
@"customer_reference": @"",
@"external_pin": @"",
@"id": @"",
@"number_level_routing": @"",
@"tags": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/phone_numbers/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/phone_numbers/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/phone_numbers/:id",
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([
'billing_group_id' => '',
'connection_id' => '',
'customer_reference' => '',
'external_pin' => '',
'id' => '',
'number_level_routing' => '',
'tags' => [
]
]),
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;
}
request('PATCH', '{{baseUrl}}/phone_numbers/:id', [
'body' => '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/phone_numbers/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'billing_group_id' => '',
'connection_id' => '',
'customer_reference' => '',
'external_pin' => '',
'id' => '',
'number_level_routing' => '',
'tags' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'billing_group_id' => '',
'connection_id' => '',
'customer_reference' => '',
'external_pin' => '',
'id' => '',
'number_level_routing' => '',
'tags' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/phone_numbers/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/phone_numbers/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/phone_numbers/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/phone_numbers/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/phone_numbers/:id"
payload = {
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/phone_numbers/:id"
payload <- "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/phone_numbers/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/phone_numbers/:id') do |req|
req.body = "{\n \"billing_group_id\": \"\",\n \"connection_id\": \"\",\n \"customer_reference\": \"\",\n \"external_pin\": \"\",\n \"id\": \"\",\n \"number_level_routing\": \"\",\n \"tags\": []\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/phone_numbers/:id";
let payload = json!({
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/phone_numbers/:id \
--header 'content-type: application/json' \
--data '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
}'
echo '{
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
}' | \
http PATCH {{baseUrl}}/phone_numbers/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "billing_group_id": "",\n "connection_id": "",\n "customer_reference": "",\n "external_pin": "",\n "id": "",\n "number_level_routing": "",\n "tags": []\n}' \
--output-document \
- {{baseUrl}}/phone_numbers/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"billing_group_id": "",
"connection_id": "",
"customer_reference": "",
"external_pin": "",
"id": "",
"number_level_routing": "",
"tags": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/phone_numbers/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"call_forwarding_enabled": true,
"call_recording_enabled": true,
"caller_id_name_enabled": true,
"cnam_listing_enabled": true,
"connection_id": "1293384261075731499",
"connection_name": "connection-name",
"created_at": "2019-10-23T18:10:00.000Z",
"customer_reference": "customer-reference",
"emergency_address_id": "1315261609962112019",
"emergency_enabled": true,
"external_pin": "1234",
"id": "1293384261075731499",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
"messaging_profile_name": "regional-customers",
"number_level_routing": "disabled",
"phone_number": "+19705555098",
"phone_number_type": "longcode",
"purchased_at": "2019-10-23T18:10:00.000Z",
"record_type": "phone_number",
"status": "active",
"t38_fax_gateway_enabled": true,
"tags": [
"tag_1",
"tag_2"
],
"updated_at": "2019-10-24T18:10:00.000Z"
}
}
GET
Lookup phone number data
{{baseUrl}}/number_lookup/:phone_number
QUERY PARAMS
phone_number
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_lookup/:phone_number");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_lookup/:phone_number")
require "http/client"
url = "{{baseUrl}}/number_lookup/:phone_number"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_lookup/:phone_number"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_lookup/:phone_number");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_lookup/:phone_number"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_lookup/:phone_number HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_lookup/:phone_number")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_lookup/:phone_number"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_lookup/:phone_number")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_lookup/:phone_number")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_lookup/:phone_number');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/number_lookup/:phone_number'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_lookup/:phone_number';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_lookup/:phone_number',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_lookup/:phone_number")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_lookup/:phone_number',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/number_lookup/:phone_number'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_lookup/:phone_number');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/number_lookup/:phone_number'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_lookup/:phone_number';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_lookup/:phone_number"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_lookup/:phone_number" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_lookup/:phone_number",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_lookup/:phone_number');
echo $response->getBody();
setUrl('{{baseUrl}}/number_lookup/:phone_number');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_lookup/:phone_number');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_lookup/:phone_number' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_lookup/:phone_number' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_lookup/:phone_number")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_lookup/:phone_number"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_lookup/:phone_number"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_lookup/:phone_number")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_lookup/:phone_number') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_lookup/:phone_number";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_lookup/:phone_number
http GET {{baseUrl}}/number_lookup/:phone_number
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_lookup/:phone_number
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_lookup/:phone_number")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"country_code": "US",
"fraud": null,
"national_format": "(0312) 945-7420",
"phone_number": "+13129457420",
"record_type": "number_lookup"
}
}
POST
Create a number order document
{{baseUrl}}/number_order_documents
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_order_documents");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/number_order_documents")
require "http/client"
url = "{{baseUrl}}/number_order_documents"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/number_order_documents"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_order_documents");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_order_documents"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/number_order_documents HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/number_order_documents")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_order_documents"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_order_documents")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/number_order_documents")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/number_order_documents');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/number_order_documents'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_order_documents';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_order_documents',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_order_documents")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_order_documents',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/number_order_documents'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/number_order_documents');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/number_order_documents'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_order_documents';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_order_documents"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_order_documents" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_order_documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/number_order_documents');
echo $response->getBody();
setUrl('{{baseUrl}}/number_order_documents');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_order_documents');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_order_documents' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_order_documents' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/number_order_documents", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_order_documents"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_order_documents"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_order_documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/number_order_documents') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_order_documents";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/number_order_documents
http POST {{baseUrl}}/number_order_documents
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/number_order_documents
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_order_documents")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
"id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
"record_type": "number_order_document",
"requirement_type": "address_proof",
"requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
}
}
GET
List number order documents
{{baseUrl}}/number_order_documents
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_order_documents");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_order_documents")
require "http/client"
url = "{{baseUrl}}/number_order_documents"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_order_documents"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_order_documents");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_order_documents"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_order_documents HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_order_documents")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_order_documents"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_order_documents")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_order_documents")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_order_documents');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/number_order_documents'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_order_documents';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_order_documents',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_order_documents")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_order_documents',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/number_order_documents'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_order_documents');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/number_order_documents'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_order_documents';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_order_documents"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_order_documents" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_order_documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_order_documents');
echo $response->getBody();
setUrl('{{baseUrl}}/number_order_documents');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_order_documents');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_order_documents' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_order_documents' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_order_documents")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_order_documents"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_order_documents"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_order_documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_order_documents') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_order_documents";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_order_documents
http GET {{baseUrl}}/number_order_documents
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_order_documents
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_order_documents")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
"id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
"record_type": "number_order_document",
"requirement_type": "address_proof",
"requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a number order document
{{baseUrl}}/number_order_documents/:number_order_document_id
QUERY PARAMS
number_order_document_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_order_documents/:number_order_document_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_order_documents/:number_order_document_id")
require "http/client"
url = "{{baseUrl}}/number_order_documents/:number_order_document_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_order_documents/:number_order_document_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_order_documents/:number_order_document_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_order_documents/:number_order_document_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_order_documents/:number_order_document_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_order_documents/:number_order_document_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_order_documents/:number_order_document_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_order_documents/:number_order_document_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_order_documents/:number_order_document_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_order_documents/:number_order_document_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/number_order_documents/:number_order_document_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_order_documents/:number_order_document_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_order_documents/:number_order_document_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_order_documents/:number_order_document_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_order_documents/:number_order_document_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/number_order_documents/:number_order_document_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_order_documents/:number_order_document_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/number_order_documents/:number_order_document_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_order_documents/:number_order_document_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_order_documents/:number_order_document_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_order_documents/:number_order_document_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_order_documents/:number_order_document_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_order_documents/:number_order_document_id');
echo $response->getBody();
setUrl('{{baseUrl}}/number_order_documents/:number_order_document_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_order_documents/:number_order_document_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_order_documents/:number_order_document_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_order_documents/:number_order_document_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_order_documents/:number_order_document_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_order_documents/:number_order_document_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_order_documents/:number_order_document_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_order_documents/:number_order_document_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_order_documents/:number_order_document_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_order_documents/:number_order_document_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_order_documents/:number_order_document_id
http GET {{baseUrl}}/number_order_documents/:number_order_document_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_order_documents/:number_order_document_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_order_documents/:number_order_document_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
"id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
"record_type": "number_order_document",
"requirement_type": "address_proof",
"requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
}
}
PATCH
Update a number order document
{{baseUrl}}/number_order_documents/:number_order_document_id
QUERY PARAMS
number_order_document_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_order_documents/:number_order_document_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/number_order_documents/:number_order_document_id")
require "http/client"
url = "{{baseUrl}}/number_order_documents/:number_order_document_id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/number_order_documents/:number_order_document_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_order_documents/:number_order_document_id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_order_documents/:number_order_document_id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/number_order_documents/:number_order_document_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/number_order_documents/:number_order_document_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_order_documents/:number_order_document_id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_order_documents/:number_order_document_id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/number_order_documents/:number_order_document_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/number_order_documents/:number_order_document_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_order_documents/:number_order_document_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_order_documents/:number_order_document_id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_order_documents/:number_order_document_id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_order_documents/:number_order_document_id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_order_documents/:number_order_document_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_order_documents/:number_order_document_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/number_order_documents/:number_order_document_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_order_documents/:number_order_document_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_order_documents/:number_order_document_id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_order_documents/:number_order_document_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_order_documents/:number_order_document_id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_order_documents/:number_order_document_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/number_order_documents/:number_order_document_id');
echo $response->getBody();
setUrl('{{baseUrl}}/number_order_documents/:number_order_document_id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_order_documents/:number_order_document_id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_order_documents/:number_order_document_id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_order_documents/:number_order_document_id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("PATCH", "/baseUrl/number_order_documents/:number_order_document_id", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_order_documents/:number_order_document_id"
payload = ""
response = requests.patch(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_order_documents/:number_order_document_id"
payload <- ""
response <- VERB("PATCH", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_order_documents/:number_order_document_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/number_order_documents/:number_order_document_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_order_documents/:number_order_document_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/number_order_documents/:number_order_document_id
http PATCH {{baseUrl}}/number_order_documents/:number_order_document_id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/number_order_documents/:number_order_document_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_order_documents/:number_order_document_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976",
"id": "387d1e31-a218-4375-8151-103f2d5e2d2c",
"record_type": "number_order_document",
"requirement_type": "address_proof",
"requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292"
}
}
POST
Create a comment
{{baseUrl}}/comments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/comments");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/comments")
require "http/client"
url = "{{baseUrl}}/comments"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/comments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/comments");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/comments"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/comments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/comments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/comments"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/comments")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/comments")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/comments');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/comments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/comments';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/comments',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/comments")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/comments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/comments'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/comments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/comments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/comments';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/comments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/comments" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/comments');
echo $response->getBody();
setUrl('{{baseUrl}}/comments');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/comments');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/comments' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/comments' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/comments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/comments"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/comments"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/comments') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/comments";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/comments
http POST {{baseUrl}}/comments
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/comments
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/comments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create a number order
{{baseUrl}}/number_orders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_orders");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/number_orders" {:content-type :json
:form-params {:billing_group_id "abc85f64-5717-4562-b3fc-2c9600"
:connection_id "346789098765567"
:created_at "2018-01-01T00:00:00.000000Z"
:customer_reference "MY REF 001"
:id "12ade33a-21c0-473b-b055-b3c836e1c292"
:messaging_profile_id "abc85f64-5717-4562-b3fc-2c9600"
:phone_numbers [{:id "dc8e4d67-33a0-4cbb-af74-7b58f05bd494"
:phone_number "+19705555098"
:record_type "number_order_phone_number"
:regulatory_group_id "dc8e4d67-33a0-4cbb-af74-7b58f05bd494"
:regulatory_requirements [{:field_type "address"
:field_value "45f45a04-b4be-4592-95b1-9306b9db2b21"
:record_type "phone_number_regulatory_requirement"
:requirement_id "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"}]
:requirements_met true
:status "success"}]
:phone_numbers_count 1
:record_type "number_order"
:requirements_met true
:status "pending"
:updated_at "2018-01-01T00:00:00.000000Z"}})
require "http/client"
url = "{{baseUrl}}/number_orders"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/number_orders"),
Content = new StringContent("{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_orders");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_orders"
payload := strings.NewReader("{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/number_orders HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 1048
{
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/number_orders")
.setHeader("content-type", "application/json")
.setBody("{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_orders"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/number_orders")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/number_orders")
.header("content-type", "application/json")
.body("{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
.asString();
const data = JSON.stringify({
billing_group_id: 'abc85f64-5717-4562-b3fc-2c9600',
connection_id: '346789098765567',
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
messaging_profile_id: 'abc85f64-5717-4562-b3fc-2c9600',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/number_orders');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/number_orders',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: 'abc85f64-5717-4562-b3fc-2c9600',
connection_id: '346789098765567',
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
messaging_profile_id: 'abc85f64-5717-4562-b3fc-2c9600',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_orders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"abc85f64-5717-4562-b3fc-2c9600","connection_id":"346789098765567","created_at":"2018-01-01T00:00:00.000000Z","customer_reference":"MY REF 001","id":"12ade33a-21c0-473b-b055-b3c836e1c292","messaging_profile_id":"abc85f64-5717-4562-b3fc-2c9600","phone_numbers":[{"id":"dc8e4d67-33a0-4cbb-af74-7b58f05bd494","phone_number":"+19705555098","record_type":"number_order_phone_number","regulatory_group_id":"dc8e4d67-33a0-4cbb-af74-7b58f05bd494","regulatory_requirements":[{"field_type":"address","field_value":"45f45a04-b4be-4592-95b1-9306b9db2b21","record_type":"phone_number_regulatory_requirement","requirement_id":"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"}],"requirements_met":true,"status":"success"}],"phone_numbers_count":1,"record_type":"number_order","requirements_met":true,"status":"pending","updated_at":"2018-01-01T00:00:00.000000Z"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_orders',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",\n "connection_id": "346789098765567",\n "created_at": "2018-01-01T00:00:00.000000Z",\n "customer_reference": "MY REF 001",\n "id": "12ade33a-21c0-473b-b055-b3c836e1c292",\n "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",\n "phone_numbers": [\n {\n "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",\n "phone_number": "+19705555098",\n "record_type": "number_order_phone_number",\n "regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",\n "regulatory_requirements": [\n {\n "field_type": "address",\n "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",\n "record_type": "phone_number_regulatory_requirement",\n "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"\n }\n ],\n "requirements_met": true,\n "status": "success"\n }\n ],\n "phone_numbers_count": 1,\n "record_type": "number_order",\n "requirements_met": true,\n "status": "pending",\n "updated_at": "2018-01-01T00:00:00.000000Z"\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/number_orders")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_orders',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
billing_group_id: 'abc85f64-5717-4562-b3fc-2c9600',
connection_id: '346789098765567',
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
messaging_profile_id: 'abc85f64-5717-4562-b3fc-2c9600',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/number_orders',
headers: {'content-type': 'application/json'},
body: {
billing_group_id: 'abc85f64-5717-4562-b3fc-2c9600',
connection_id: '346789098765567',
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
messaging_profile_id: 'abc85f64-5717-4562-b3fc-2c9600',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/number_orders');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
billing_group_id: 'abc85f64-5717-4562-b3fc-2c9600',
connection_id: '346789098765567',
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
messaging_profile_id: 'abc85f64-5717-4562-b3fc-2c9600',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/number_orders',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: 'abc85f64-5717-4562-b3fc-2c9600',
connection_id: '346789098765567',
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
messaging_profile_id: 'abc85f64-5717-4562-b3fc-2c9600',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_orders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"abc85f64-5717-4562-b3fc-2c9600","connection_id":"346789098765567","created_at":"2018-01-01T00:00:00.000000Z","customer_reference":"MY REF 001","id":"12ade33a-21c0-473b-b055-b3c836e1c292","messaging_profile_id":"abc85f64-5717-4562-b3fc-2c9600","phone_numbers":[{"id":"dc8e4d67-33a0-4cbb-af74-7b58f05bd494","phone_number":"+19705555098","record_type":"number_order_phone_number","regulatory_group_id":"dc8e4d67-33a0-4cbb-af74-7b58f05bd494","regulatory_requirements":[{"field_type":"address","field_value":"45f45a04-b4be-4592-95b1-9306b9db2b21","record_type":"phone_number_regulatory_requirement","requirement_id":"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"}],"requirements_met":true,"status":"success"}],"phone_numbers_count":1,"record_type":"number_order","requirements_met":true,"status":"pending","updated_at":"2018-01-01T00:00:00.000000Z"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"billing_group_id": @"abc85f64-5717-4562-b3fc-2c9600",
@"connection_id": @"346789098765567",
@"created_at": @"2018-01-01T00:00:00.000000Z",
@"customer_reference": @"MY REF 001",
@"id": @"12ade33a-21c0-473b-b055-b3c836e1c292",
@"messaging_profile_id": @"abc85f64-5717-4562-b3fc-2c9600",
@"phone_numbers": @[ @{ @"id": @"dc8e4d67-33a0-4cbb-af74-7b58f05bd494", @"phone_number": @"+19705555098", @"record_type": @"number_order_phone_number", @"regulatory_group_id": @"dc8e4d67-33a0-4cbb-af74-7b58f05bd494", @"regulatory_requirements": @[ @{ @"field_type": @"address", @"field_value": @"45f45a04-b4be-4592-95b1-9306b9db2b21", @"record_type": @"phone_number_regulatory_requirement", @"requirement_id": @"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" } ], @"requirements_met": @YES, @"status": @"success" } ],
@"phone_numbers_count": @1,
@"record_type": @"number_order",
@"requirements_met": @YES,
@"status": @"pending",
@"updated_at": @"2018-01-01T00:00:00.000000Z" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_orders" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_orders",
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([
'billing_group_id' => 'abc85f64-5717-4562-b3fc-2c9600',
'connection_id' => '346789098765567',
'created_at' => '2018-01-01T00:00:00.000000Z',
'customer_reference' => 'MY REF 001',
'id' => '12ade33a-21c0-473b-b055-b3c836e1c292',
'messaging_profile_id' => 'abc85f64-5717-4562-b3fc-2c9600',
'phone_numbers' => [
[
'id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'phone_number' => '+19705555098',
'record_type' => 'number_order_phone_number',
'regulatory_group_id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'regulatory_requirements' => [
[
'field_type' => 'address',
'field_value' => '45f45a04-b4be-4592-95b1-9306b9db2b21',
'record_type' => 'phone_number_regulatory_requirement',
'requirement_id' => '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
]
],
'requirements_met' => null,
'status' => 'success'
]
],
'phone_numbers_count' => 1,
'record_type' => 'number_order',
'requirements_met' => null,
'status' => 'pending',
'updated_at' => '2018-01-01T00:00:00.000000Z'
]),
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;
}
request('POST', '{{baseUrl}}/number_orders', [
'body' => '{
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/number_orders');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'billing_group_id' => 'abc85f64-5717-4562-b3fc-2c9600',
'connection_id' => '346789098765567',
'created_at' => '2018-01-01T00:00:00.000000Z',
'customer_reference' => 'MY REF 001',
'id' => '12ade33a-21c0-473b-b055-b3c836e1c292',
'messaging_profile_id' => 'abc85f64-5717-4562-b3fc-2c9600',
'phone_numbers' => [
[
'id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'phone_number' => '+19705555098',
'record_type' => 'number_order_phone_number',
'regulatory_group_id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'regulatory_requirements' => [
[
'field_type' => 'address',
'field_value' => '45f45a04-b4be-4592-95b1-9306b9db2b21',
'record_type' => 'phone_number_regulatory_requirement',
'requirement_id' => '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
]
],
'requirements_met' => null,
'status' => 'success'
]
],
'phone_numbers_count' => 1,
'record_type' => 'number_order',
'requirements_met' => null,
'status' => 'pending',
'updated_at' => '2018-01-01T00:00:00.000000Z'
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'billing_group_id' => 'abc85f64-5717-4562-b3fc-2c9600',
'connection_id' => '346789098765567',
'created_at' => '2018-01-01T00:00:00.000000Z',
'customer_reference' => 'MY REF 001',
'id' => '12ade33a-21c0-473b-b055-b3c836e1c292',
'messaging_profile_id' => 'abc85f64-5717-4562-b3fc-2c9600',
'phone_numbers' => [
[
'id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'phone_number' => '+19705555098',
'record_type' => 'number_order_phone_number',
'regulatory_group_id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'regulatory_requirements' => [
[
'field_type' => 'address',
'field_value' => '45f45a04-b4be-4592-95b1-9306b9db2b21',
'record_type' => 'phone_number_regulatory_requirement',
'requirement_id' => '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
]
],
'requirements_met' => null,
'status' => 'success'
]
],
'phone_numbers_count' => 1,
'record_type' => 'number_order',
'requirements_met' => null,
'status' => 'pending',
'updated_at' => '2018-01-01T00:00:00.000000Z'
]));
$request->setRequestUrl('{{baseUrl}}/number_orders');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_orders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_orders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/number_orders", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_orders"
payload = {
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": True,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": True,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_orders"
payload <- "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_orders")
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 \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/number_orders') do |req|
req.body = "{\n \"billing_group_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"connection_id\": \"346789098765567\",\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"messaging_profile_id\": \"abc85f64-5717-4562-b3fc-2c9600\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_orders";
let payload = json!({
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": (
json!({
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": (
json!({
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
})
),
"requirements_met": true,
"status": "success"
})
),
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/number_orders \
--header 'content-type: application/json' \
--data '{
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}'
echo '{
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}' | \
http POST {{baseUrl}}/number_orders \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",\n "connection_id": "346789098765567",\n "created_at": "2018-01-01T00:00:00.000000Z",\n "customer_reference": "MY REF 001",\n "id": "12ade33a-21c0-473b-b055-b3c836e1c292",\n "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",\n "phone_numbers": [\n {\n "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",\n "phone_number": "+19705555098",\n "record_type": "number_order_phone_number",\n "regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",\n "regulatory_requirements": [\n {\n "field_type": "address",\n "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",\n "record_type": "phone_number_regulatory_requirement",\n "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"\n }\n ],\n "requirements_met": true,\n "status": "success"\n }\n ],\n "phone_numbers_count": 1,\n "record_type": "number_order",\n "requirements_met": true,\n "status": "pending",\n "updated_at": "2018-01-01T00:00:00.000000Z"\n}' \
--output-document \
- {{baseUrl}}/number_orders
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"connection_id": "346789098765567",
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
[
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
[
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
]
],
"requirements_met": true,
"status": "success"
]
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List number orders
{{baseUrl}}/number_orders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_orders");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_orders")
require "http/client"
url = "{{baseUrl}}/number_orders"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_orders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_orders");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_orders"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_orders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_orders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_orders"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_orders")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_orders")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_orders');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/number_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_orders',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_orders")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_orders',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/number_orders'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_orders');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/number_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_orders" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_orders');
echo $response->getBody();
setUrl('{{baseUrl}}/number_orders');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_orders');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_orders' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_orders' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_orders")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_orders"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_orders"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_orders') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_orders";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_orders
http GET {{baseUrl}}/number_orders
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_orders
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List sub number orders
{{baseUrl}}/sub_number_orders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sub_number_orders");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sub_number_orders")
require "http/client"
url = "{{baseUrl}}/sub_number_orders"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sub_number_orders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sub_number_orders");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sub_number_orders"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sub_number_orders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sub_number_orders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sub_number_orders"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sub_number_orders")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sub_number_orders")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sub_number_orders');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sub_number_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sub_number_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sub_number_orders',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sub_number_orders")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sub_number_orders',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sub_number_orders'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sub_number_orders');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sub_number_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sub_number_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sub_number_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sub_number_orders" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sub_number_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sub_number_orders');
echo $response->getBody();
setUrl('{{baseUrl}}/sub_number_orders');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sub_number_orders');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sub_number_orders' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sub_number_orders' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sub_number_orders")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sub_number_orders"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sub_number_orders"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sub_number_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sub_number_orders') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sub_number_orders";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sub_number_orders
http GET {{baseUrl}}/sub_number_orders
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sub_number_orders
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sub_number_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
PATCH
Mark a comment as read
{{baseUrl}}/comments/:id/read
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/comments/:id/read");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/comments/:id/read")
require "http/client"
url = "{{baseUrl}}/comments/:id/read"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/comments/:id/read"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/comments/:id/read");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/comments/:id/read"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/comments/:id/read HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/comments/:id/read")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/comments/:id/read"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/comments/:id/read")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/comments/:id/read")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/comments/:id/read');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PATCH', url: '{{baseUrl}}/comments/:id/read'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/comments/:id/read';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/comments/:id/read',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/comments/:id/read")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/comments/:id/read',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'PATCH', url: '{{baseUrl}}/comments/:id/read'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/comments/:id/read');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'PATCH', url: '{{baseUrl}}/comments/:id/read'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/comments/:id/read';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/comments/:id/read"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/comments/:id/read" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/comments/:id/read",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/comments/:id/read');
echo $response->getBody();
setUrl('{{baseUrl}}/comments/:id/read');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/comments/:id/read');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/comments/:id/read' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/comments/:id/read' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PATCH", "/baseUrl/comments/:id/read")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/comments/:id/read"
response = requests.patch(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/comments/:id/read"
response <- VERB("PATCH", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/comments/:id/read")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/comments/:id/read') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/comments/:id/read";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/comments/:id/read
http PATCH {{baseUrl}}/comments/:id/read
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/comments/:id/read
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/comments/:id/read")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Retrieve a comment
{{baseUrl}}/comments/:id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/comments/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/comments/:id")
require "http/client"
url = "{{baseUrl}}/comments/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/comments/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/comments/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/comments/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/comments/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/comments/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/comments/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/comments/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/comments/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/comments/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/comments/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/comments/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/comments/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/comments/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/comments/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/comments/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/comments/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/comments/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/comments/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/comments/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/comments/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/comments/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/comments/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/comments/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/comments/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/comments/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/comments/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/comments/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/comments/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/comments/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/comments/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/comments/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/comments/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/comments/:id
http GET {{baseUrl}}/comments/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/comments/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/comments/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Retrieve a list of phone numbers associated to orders
{{baseUrl}}/number_order_phone_numbers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_order_phone_numbers");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_order_phone_numbers")
require "http/client"
url = "{{baseUrl}}/number_order_phone_numbers"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_order_phone_numbers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_order_phone_numbers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_order_phone_numbers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_order_phone_numbers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_order_phone_numbers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_order_phone_numbers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_order_phone_numbers")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_order_phone_numbers")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_order_phone_numbers');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/number_order_phone_numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_order_phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_order_phone_numbers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_order_phone_numbers")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_order_phone_numbers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/number_order_phone_numbers'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_order_phone_numbers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/number_order_phone_numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_order_phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_order_phone_numbers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_order_phone_numbers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_order_phone_numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_order_phone_numbers');
echo $response->getBody();
setUrl('{{baseUrl}}/number_order_phone_numbers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_order_phone_numbers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_order_phone_numbers' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_order_phone_numbers' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_order_phone_numbers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_order_phone_numbers"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_order_phone_numbers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_order_phone_numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_order_phone_numbers') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_order_phone_numbers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_order_phone_numbers
http GET {{baseUrl}}/number_order_phone_numbers
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_order_phone_numbers
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_order_phone_numbers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a number order phone number.
{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id
QUERY PARAMS
number_order_phone_number_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
require "http/client"
url = "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_order_phone_numbers/:number_order_phone_number_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_order_phone_numbers/:number_order_phone_number_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
echo $response->getBody();
setUrl('{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_order_phone_numbers/:number_order_phone_number_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_order_phone_numbers/:number_order_phone_number_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id
http GET {{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Retrieve a number order
{{baseUrl}}/number_orders/:number_order_id
QUERY PARAMS
number_order_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_orders/:number_order_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_orders/:number_order_id")
require "http/client"
url = "{{baseUrl}}/number_orders/:number_order_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_orders/:number_order_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_orders/:number_order_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_orders/:number_order_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_orders/:number_order_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_orders/:number_order_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_orders/:number_order_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_orders/:number_order_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_orders/:number_order_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_orders/:number_order_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/number_orders/:number_order_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_orders/:number_order_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_orders/:number_order_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_orders/:number_order_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_orders/:number_order_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/number_orders/:number_order_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_orders/:number_order_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/number_orders/:number_order_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_orders/:number_order_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_orders/:number_order_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_orders/:number_order_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_orders/:number_order_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_orders/:number_order_id');
echo $response->getBody();
setUrl('{{baseUrl}}/number_orders/:number_order_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_orders/:number_order_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_orders/:number_order_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_orders/:number_order_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_orders/:number_order_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_orders/:number_order_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_orders/:number_order_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_orders/:number_order_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_orders/:number_order_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_orders/:number_order_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_orders/:number_order_id
http GET {{baseUrl}}/number_orders/:number_order_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_orders/:number_order_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_orders/:number_order_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Retrieve a sub number order
{{baseUrl}}/sub_number_orders/:sub_number_order_id
QUERY PARAMS
sub_number_order_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sub_number_orders/:sub_number_order_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sub_number_orders/:sub_number_order_id")
require "http/client"
url = "{{baseUrl}}/sub_number_orders/:sub_number_order_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sub_number_orders/:sub_number_order_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sub_number_orders/:sub_number_order_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sub_number_orders/:sub_number_order_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sub_number_orders/:sub_number_order_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sub_number_orders/:sub_number_order_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sub_number_orders/:sub_number_order_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sub_number_orders/:sub_number_order_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sub_number_orders/:sub_number_order_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sub_number_orders/:sub_number_order_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/sub_number_orders/:sub_number_order_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sub_number_orders/:sub_number_order_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sub_number_orders/:sub_number_order_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sub_number_orders/:sub_number_order_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sub_number_orders/:sub_number_order_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/sub_number_orders/:sub_number_order_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sub_number_orders/:sub_number_order_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/sub_number_orders/:sub_number_order_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sub_number_orders/:sub_number_order_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sub_number_orders/:sub_number_order_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sub_number_orders/:sub_number_order_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sub_number_orders/:sub_number_order_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sub_number_orders/:sub_number_order_id');
echo $response->getBody();
setUrl('{{baseUrl}}/sub_number_orders/:sub_number_order_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sub_number_orders/:sub_number_order_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sub_number_orders/:sub_number_order_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sub_number_orders/:sub_number_order_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sub_number_orders/:sub_number_order_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sub_number_orders/:sub_number_order_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sub_number_orders/:sub_number_order_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sub_number_orders/:sub_number_order_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sub_number_orders/:sub_number_order_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sub_number_orders/:sub_number_order_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sub_number_orders/:sub_number_order_id
http GET {{baseUrl}}/sub_number_orders/:sub_number_order_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sub_number_orders/:sub_number_order_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sub_number_orders/:sub_number_order_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Retrieve all comments
{{baseUrl}}/comments
QUERY PARAMS
filter[comment_record_type]
filter[comment_record_id]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/comments" {:query-params {:filter[comment_record_type] ""
:filter[comment_record_id] ""}})
require "http/client"
url = "{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D="
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D="
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D="))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/comments',
params: {'filter[comment_record_type]': '', 'filter[comment_record_id]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/comments',
qs: {'filter[comment_record_type]': '', 'filter[comment_record_id]': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/comments');
req.query({
'filter[comment_record_type]': '',
'filter[comment_record_id]': ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/comments',
params: {'filter[comment_record_type]': '', 'filter[comment_record_id]': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D="]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=');
echo $response->getBody();
setUrl('{{baseUrl}}/comments');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'filter[comment_record_type]' => '',
'filter[comment_record_id]' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/comments');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'filter[comment_record_type]' => '',
'filter[comment_record_id]' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/comments"
querystring = {"filter[comment_record_type]":"","filter[comment_record_id]":""}
response = requests.get(url, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/comments"
queryString <- list(
filter[comment_record_type] = "",
filter[comment_record_id] = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/comments') do |req|
req.params['filter[comment_record_type]'] = ''
req.params['filter[comment_record_id]'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/comments";
let querystring = [
("filter[comment_record_type]", ""),
("filter[comment_record_id]", ""),
];
let client = reqwest::Client::new();
let response = client.get(url)
.query(&querystring)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D='
http GET '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D='
wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D='
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/comments?filter%5Bcomment_record_type%5D=&filter%5Bcomment_record_id%5D=")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
PATCH
Update a number order phone number.
{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id
QUERY PARAMS
number_order_phone_number_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
require "http/client"
url = "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/number_order_phone_numbers/:number_order_phone_number_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_order_phone_numbers/:number_order_phone_number_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
echo $response->getBody();
setUrl('{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PATCH", "/baseUrl/number_order_phone_numbers/:number_order_phone_number_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"
response = requests.patch(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id"
response <- VERB("PATCH", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/number_order_phone_numbers/:number_order_phone_number_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id
http PATCH {{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_order_phone_numbers/:number_order_phone_number_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PATCH
Update a number order
{{baseUrl}}/number_orders/:number_order_id
QUERY PARAMS
number_order_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_orders/:number_order_id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/number_orders/:number_order_id" {:content-type :json
:form-params {:created_at "2018-01-01T00:00:00.000000Z"
:customer_reference "MY REF 001"
:id "12ade33a-21c0-473b-b055-b3c836e1c292"
:phone_numbers [{:id "dc8e4d67-33a0-4cbb-af74-7b58f05bd494"
:phone_number "+19705555098"
:record_type "number_order_phone_number"
:regulatory_group_id "dc8e4d67-33a0-4cbb-af74-7b58f05bd494"
:regulatory_requirements [{:field_type "address"
:field_value "45f45a04-b4be-4592-95b1-9306b9db2b21"
:record_type "phone_number_regulatory_requirement"
:requirement_id "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"}]
:requirements_met true
:status "success"}]
:phone_numbers_count 1
:record_type "number_order"
:requirements_met true
:status "pending"
:updated_at "2018-01-01T00:00:00.000000Z"}})
require "http/client"
url = "{{baseUrl}}/number_orders/:number_order_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/number_orders/:number_order_id"),
Content = new StringContent("{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_orders/:number_order_id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_orders/:number_order_id"
payload := strings.NewReader("{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/number_orders/:number_order_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 894
{
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/number_orders/:number_order_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_orders/:number_order_id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/number_orders/:number_order_id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/number_orders/:number_order_id")
.header("content-type", "application/json")
.body("{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
.asString();
const data = JSON.stringify({
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/number_orders/:number_order_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_orders/:number_order_id',
headers: {'content-type': 'application/json'},
data: {
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_orders/:number_order_id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"created_at":"2018-01-01T00:00:00.000000Z","customer_reference":"MY REF 001","id":"12ade33a-21c0-473b-b055-b3c836e1c292","phone_numbers":[{"id":"dc8e4d67-33a0-4cbb-af74-7b58f05bd494","phone_number":"+19705555098","record_type":"number_order_phone_number","regulatory_group_id":"dc8e4d67-33a0-4cbb-af74-7b58f05bd494","regulatory_requirements":[{"field_type":"address","field_value":"45f45a04-b4be-4592-95b1-9306b9db2b21","record_type":"phone_number_regulatory_requirement","requirement_id":"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"}],"requirements_met":true,"status":"success"}],"phone_numbers_count":1,"record_type":"number_order","requirements_met":true,"status":"pending","updated_at":"2018-01-01T00:00:00.000000Z"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_orders/:number_order_id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "created_at": "2018-01-01T00:00:00.000000Z",\n "customer_reference": "MY REF 001",\n "id": "12ade33a-21c0-473b-b055-b3c836e1c292",\n "phone_numbers": [\n {\n "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",\n "phone_number": "+19705555098",\n "record_type": "number_order_phone_number",\n "regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",\n "regulatory_requirements": [\n {\n "field_type": "address",\n "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",\n "record_type": "phone_number_regulatory_requirement",\n "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"\n }\n ],\n "requirements_met": true,\n "status": "success"\n }\n ],\n "phone_numbers_count": 1,\n "record_type": "number_order",\n "requirements_met": true,\n "status": "pending",\n "updated_at": "2018-01-01T00:00:00.000000Z"\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/number_orders/:number_order_id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_orders/:number_order_id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_orders/:number_order_id',
headers: {'content-type': 'application/json'},
body: {
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/number_orders/:number_order_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/number_orders/:number_order_id',
headers: {'content-type': 'application/json'},
data: {
created_at: '2018-01-01T00:00:00.000000Z',
customer_reference: 'MY REF 001',
id: '12ade33a-21c0-473b-b055-b3c836e1c292',
phone_numbers: [
{
id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
phone_number: '+19705555098',
record_type: 'number_order_phone_number',
regulatory_group_id: 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
regulatory_requirements: [
{
field_type: 'address',
field_value: '45f45a04-b4be-4592-95b1-9306b9db2b21',
record_type: 'phone_number_regulatory_requirement',
requirement_id: '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
}
],
requirements_met: true,
status: 'success'
}
],
phone_numbers_count: 1,
record_type: 'number_order',
requirements_met: true,
status: 'pending',
updated_at: '2018-01-01T00:00:00.000000Z'
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_orders/:number_order_id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"created_at":"2018-01-01T00:00:00.000000Z","customer_reference":"MY REF 001","id":"12ade33a-21c0-473b-b055-b3c836e1c292","phone_numbers":[{"id":"dc8e4d67-33a0-4cbb-af74-7b58f05bd494","phone_number":"+19705555098","record_type":"number_order_phone_number","regulatory_group_id":"dc8e4d67-33a0-4cbb-af74-7b58f05bd494","regulatory_requirements":[{"field_type":"address","field_value":"45f45a04-b4be-4592-95b1-9306b9db2b21","record_type":"phone_number_regulatory_requirement","requirement_id":"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"}],"requirements_met":true,"status":"success"}],"phone_numbers_count":1,"record_type":"number_order","requirements_met":true,"status":"pending","updated_at":"2018-01-01T00:00:00.000000Z"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"created_at": @"2018-01-01T00:00:00.000000Z",
@"customer_reference": @"MY REF 001",
@"id": @"12ade33a-21c0-473b-b055-b3c836e1c292",
@"phone_numbers": @[ @{ @"id": @"dc8e4d67-33a0-4cbb-af74-7b58f05bd494", @"phone_number": @"+19705555098", @"record_type": @"number_order_phone_number", @"regulatory_group_id": @"dc8e4d67-33a0-4cbb-af74-7b58f05bd494", @"regulatory_requirements": @[ @{ @"field_type": @"address", @"field_value": @"45f45a04-b4be-4592-95b1-9306b9db2b21", @"record_type": @"phone_number_regulatory_requirement", @"requirement_id": @"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" } ], @"requirements_met": @YES, @"status": @"success" } ],
@"phone_numbers_count": @1,
@"record_type": @"number_order",
@"requirements_met": @YES,
@"status": @"pending",
@"updated_at": @"2018-01-01T00:00:00.000000Z" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_orders/:number_order_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_orders/:number_order_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_orders/:number_order_id",
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([
'created_at' => '2018-01-01T00:00:00.000000Z',
'customer_reference' => 'MY REF 001',
'id' => '12ade33a-21c0-473b-b055-b3c836e1c292',
'phone_numbers' => [
[
'id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'phone_number' => '+19705555098',
'record_type' => 'number_order_phone_number',
'regulatory_group_id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'regulatory_requirements' => [
[
'field_type' => 'address',
'field_value' => '45f45a04-b4be-4592-95b1-9306b9db2b21',
'record_type' => 'phone_number_regulatory_requirement',
'requirement_id' => '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
]
],
'requirements_met' => null,
'status' => 'success'
]
],
'phone_numbers_count' => 1,
'record_type' => 'number_order',
'requirements_met' => null,
'status' => 'pending',
'updated_at' => '2018-01-01T00:00:00.000000Z'
]),
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;
}
request('PATCH', '{{baseUrl}}/number_orders/:number_order_id', [
'body' => '{
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/number_orders/:number_order_id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'created_at' => '2018-01-01T00:00:00.000000Z',
'customer_reference' => 'MY REF 001',
'id' => '12ade33a-21c0-473b-b055-b3c836e1c292',
'phone_numbers' => [
[
'id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'phone_number' => '+19705555098',
'record_type' => 'number_order_phone_number',
'regulatory_group_id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'regulatory_requirements' => [
[
'field_type' => 'address',
'field_value' => '45f45a04-b4be-4592-95b1-9306b9db2b21',
'record_type' => 'phone_number_regulatory_requirement',
'requirement_id' => '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
]
],
'requirements_met' => null,
'status' => 'success'
]
],
'phone_numbers_count' => 1,
'record_type' => 'number_order',
'requirements_met' => null,
'status' => 'pending',
'updated_at' => '2018-01-01T00:00:00.000000Z'
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'created_at' => '2018-01-01T00:00:00.000000Z',
'customer_reference' => 'MY REF 001',
'id' => '12ade33a-21c0-473b-b055-b3c836e1c292',
'phone_numbers' => [
[
'id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'phone_number' => '+19705555098',
'record_type' => 'number_order_phone_number',
'regulatory_group_id' => 'dc8e4d67-33a0-4cbb-af74-7b58f05bd494',
'regulatory_requirements' => [
[
'field_type' => 'address',
'field_value' => '45f45a04-b4be-4592-95b1-9306b9db2b21',
'record_type' => 'phone_number_regulatory_requirement',
'requirement_id' => '8ffb3622-7c6b-4ccc-b65f-7a3dc0099576'
]
],
'requirements_met' => null,
'status' => 'success'
]
],
'phone_numbers_count' => 1,
'record_type' => 'number_order',
'requirements_met' => null,
'status' => 'pending',
'updated_at' => '2018-01-01T00:00:00.000000Z'
]));
$request->setRequestUrl('{{baseUrl}}/number_orders/:number_order_id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_orders/:number_order_id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_orders/:number_order_id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/number_orders/:number_order_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_orders/:number_order_id"
payload = {
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": True,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": True,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_orders/:number_order_id"
payload <- "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_orders/:number_order_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/number_orders/:number_order_id') do |req|
req.body = "{\n \"created_at\": \"2018-01-01T00:00:00.000000Z\",\n \"customer_reference\": \"MY REF 001\",\n \"id\": \"12ade33a-21c0-473b-b055-b3c836e1c292\",\n \"phone_numbers\": [\n {\n \"id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"phone_number\": \"+19705555098\",\n \"record_type\": \"number_order_phone_number\",\n \"regulatory_group_id\": \"dc8e4d67-33a0-4cbb-af74-7b58f05bd494\",\n \"regulatory_requirements\": [\n {\n \"field_type\": \"address\",\n \"field_value\": \"45f45a04-b4be-4592-95b1-9306b9db2b21\",\n \"record_type\": \"phone_number_regulatory_requirement\",\n \"requirement_id\": \"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576\"\n }\n ],\n \"requirements_met\": true,\n \"status\": \"success\"\n }\n ],\n \"phone_numbers_count\": 1,\n \"record_type\": \"number_order\",\n \"requirements_met\": true,\n \"status\": \"pending\",\n \"updated_at\": \"2018-01-01T00:00:00.000000Z\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_orders/:number_order_id";
let payload = json!({
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": (
json!({
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": (
json!({
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
})
),
"requirements_met": true,
"status": "success"
})
),
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/number_orders/:number_order_id \
--header 'content-type: application/json' \
--data '{
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}'
echo '{
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}' | \
http PATCH {{baseUrl}}/number_orders/:number_order_id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "created_at": "2018-01-01T00:00:00.000000Z",\n "customer_reference": "MY REF 001",\n "id": "12ade33a-21c0-473b-b055-b3c836e1c292",\n "phone_numbers": [\n {\n "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",\n "phone_number": "+19705555098",\n "record_type": "number_order_phone_number",\n "regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",\n "regulatory_requirements": [\n {\n "field_type": "address",\n "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",\n "record_type": "phone_number_regulatory_requirement",\n "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"\n }\n ],\n "requirements_met": true,\n "status": "success"\n }\n ],\n "phone_numbers_count": 1,\n "record_type": "number_order",\n "requirements_met": true,\n "status": "pending",\n "updated_at": "2018-01-01T00:00:00.000000Z"\n}' \
--output-document \
- {{baseUrl}}/number_orders/:number_order_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
[
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
[
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
]
],
"requirements_met": true,
"status": "success"
]
],
"phone_numbers_count": 1,
"record_type": "number_order",
"requirements_met": true,
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_orders/:number_order_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PATCH
Update a sub number order
{{baseUrl}}/sub_number_orders/:sub_number_order_id
QUERY PARAMS
sub_number_order_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sub_number_orders/:sub_number_order_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/sub_number_orders/:sub_number_order_id")
require "http/client"
url = "{{baseUrl}}/sub_number_orders/:sub_number_order_id"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/sub_number_orders/:sub_number_order_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sub_number_orders/:sub_number_order_id");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sub_number_orders/:sub_number_order_id"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/sub_number_orders/:sub_number_order_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/sub_number_orders/:sub_number_order_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sub_number_orders/:sub_number_order_id"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sub_number_orders/:sub_number_order_id")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/sub_number_orders/:sub_number_order_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/sub_number_orders/:sub_number_order_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sub_number_orders/:sub_number_order_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sub_number_orders/:sub_number_order_id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sub_number_orders/:sub_number_order_id',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sub_number_orders/:sub_number_order_id")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/sub_number_orders/:sub_number_order_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sub_number_orders/:sub_number_order_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/sub_number_orders/:sub_number_order_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sub_number_orders/:sub_number_order_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sub_number_orders/:sub_number_order_id';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sub_number_orders/:sub_number_order_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sub_number_orders/:sub_number_order_id" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sub_number_orders/:sub_number_order_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/sub_number_orders/:sub_number_order_id');
echo $response->getBody();
setUrl('{{baseUrl}}/sub_number_orders/:sub_number_order_id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sub_number_orders/:sub_number_order_id');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sub_number_orders/:sub_number_order_id' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sub_number_orders/:sub_number_order_id' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PATCH", "/baseUrl/sub_number_orders/:sub_number_order_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sub_number_orders/:sub_number_order_id"
response = requests.patch(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sub_number_orders/:sub_number_order_id"
response <- VERB("PATCH", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sub_number_orders/:sub_number_order_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/sub_number_orders/:sub_number_order_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sub_number_orders/:sub_number_order_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/sub_number_orders/:sub_number_order_id
http PATCH {{baseUrl}}/sub_number_orders/:sub_number_order_id
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/sub_number_orders/:sub_number_order_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sub_number_orders/:sub_number_order_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create a comment on a portout request
{{baseUrl}}/portouts/:id/comments
QUERY PARAMS
id
BODY json
{
"body": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/portouts/:id/comments");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"body\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/portouts/:id/comments" {:content-type :json
:form-params {:body ""}})
require "http/client"
url = "{{baseUrl}}/portouts/:id/comments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"body\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/portouts/:id/comments"),
Content = new StringContent("{\n \"body\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/portouts/:id/comments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"body\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/portouts/:id/comments"
payload := strings.NewReader("{\n \"body\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/portouts/:id/comments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 16
{
"body": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/portouts/:id/comments")
.setHeader("content-type", "application/json")
.setBody("{\n \"body\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/portouts/:id/comments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"body\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"body\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/portouts/:id/comments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/portouts/:id/comments")
.header("content-type", "application/json")
.body("{\n \"body\": \"\"\n}")
.asString();
const data = JSON.stringify({
body: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/portouts/:id/comments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/portouts/:id/comments',
headers: {'content-type': 'application/json'},
data: {body: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/portouts/:id/comments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"body":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/portouts/:id/comments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "body": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"body\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/portouts/:id/comments")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/portouts/:id/comments',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({body: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/portouts/:id/comments',
headers: {'content-type': 'application/json'},
body: {body: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/portouts/:id/comments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
body: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/portouts/:id/comments',
headers: {'content-type': 'application/json'},
data: {body: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/portouts/:id/comments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"body":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"body": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/portouts/:id/comments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/portouts/:id/comments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"body\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/portouts/:id/comments",
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([
'body' => ''
]),
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;
}
request('POST', '{{baseUrl}}/portouts/:id/comments', [
'body' => '{
"body": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/portouts/:id/comments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'body' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'body' => ''
]));
$request->setRequestUrl('{{baseUrl}}/portouts/:id/comments');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/portouts/:id/comments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"body": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/portouts/:id/comments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"body": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"body\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/portouts/:id/comments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/portouts/:id/comments"
payload = { "body": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/portouts/:id/comments"
payload <- "{\n \"body\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/portouts/:id/comments")
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 \"body\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/portouts/:id/comments') do |req|
req.body = "{\n \"body\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/portouts/:id/comments";
let payload = json!({"body": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/portouts/:id/comments \
--header 'content-type: application/json' \
--data '{
"body": ""
}'
echo '{
"body": ""
}' | \
http POST {{baseUrl}}/portouts/:id/comments \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "body": ""\n}' \
--output-document \
- {{baseUrl}}/portouts/:id/comments
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["body": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/portouts/:id/comments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"body": "This is a comment",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"record_type": "portout",
"user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
}
}
GET
List all comments for a portout request
{{baseUrl}}/portouts/:id/comments
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/portouts/:id/comments");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/portouts/:id/comments")
require "http/client"
url = "{{baseUrl}}/portouts/:id/comments"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/portouts/:id/comments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/portouts/:id/comments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/portouts/:id/comments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/portouts/:id/comments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/portouts/:id/comments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/portouts/:id/comments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/portouts/:id/comments")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/portouts/:id/comments")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/portouts/:id/comments');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/portouts/:id/comments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/portouts/:id/comments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/portouts/:id/comments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/portouts/:id/comments")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/portouts/:id/comments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/portouts/:id/comments'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/portouts/:id/comments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/portouts/:id/comments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/portouts/:id/comments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/portouts/:id/comments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/portouts/:id/comments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/portouts/:id/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/portouts/:id/comments');
echo $response->getBody();
setUrl('{{baseUrl}}/portouts/:id/comments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/portouts/:id/comments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/portouts/:id/comments' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/portouts/:id/comments' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/portouts/:id/comments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/portouts/:id/comments"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/portouts/:id/comments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/portouts/:id/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/portouts/:id/comments') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/portouts/:id/comments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/portouts/:id/comments
http GET {{baseUrl}}/portouts/:id/comments
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/portouts/:id/comments
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/portouts/:id/comments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"body": "This is a comment",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"record_type": "portout",
"user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
}
],
"meta": {
"page_number": 3,
"page_size": 1,
"total_pages": 13,
"total_results": 13
}
}
GET
Retrieve a list of portout requests
{{baseUrl}}/portouts
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/portouts");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/portouts")
require "http/client"
url = "{{baseUrl}}/portouts"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/portouts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/portouts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/portouts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/portouts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/portouts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/portouts"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/portouts")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/portouts")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/portouts');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/portouts'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/portouts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/portouts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/portouts")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/portouts',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/portouts'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/portouts');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/portouts'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/portouts';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/portouts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/portouts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/portouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/portouts');
echo $response->getBody();
setUrl('{{baseUrl}}/portouts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/portouts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/portouts' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/portouts' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/portouts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/portouts"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/portouts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/portouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/portouts') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/portouts";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/portouts
http GET {{baseUrl}}/portouts
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/portouts
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/portouts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"carrier_name": "test",
"created_at": "2018-02-02T22:25:27.521Z",
"foc_date": "2018-02-02T22:25:27.521Z",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"phone_numbers": [
"+35312345678"
],
"record_type": "portout",
"requested_foc_date": "2018-02-02T22:25:27.521Z",
"spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"status": "pending",
"updated_at": "2018-02-02T22:25:27.521Z"
}
],
"meta": {
"page_number": 3,
"page_size": 1,
"total_pages": 13,
"total_results": 13
}
}
GET
Retrieve a portout request
{{baseUrl}}/portouts/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/portouts/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/portouts/:id")
require "http/client"
url = "{{baseUrl}}/portouts/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/portouts/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/portouts/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/portouts/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/portouts/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/portouts/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/portouts/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/portouts/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/portouts/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/portouts/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/portouts/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/portouts/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/portouts/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/portouts/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/portouts/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/portouts/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/portouts/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/portouts/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/portouts/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/portouts/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/portouts/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/portouts/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/portouts/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/portouts/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/portouts/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/portouts/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/portouts/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/portouts/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/portouts/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/portouts/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/portouts/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/portouts/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/portouts/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/portouts/:id
http GET {{baseUrl}}/portouts/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/portouts/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/portouts/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"carrier_name": "test",
"created_at": "2018-02-02T22:25:27.521Z",
"foc_date": "2018-02-02T22:25:27.521Z",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"phone_numbers": [
"+35312345678"
],
"record_type": "portout",
"requested_foc_date": "2018-02-02T22:25:27.521Z",
"spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"status": "pending",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
PATCH
Update Status
{{baseUrl}}/portouts/:id/:status
QUERY PARAMS
id
status
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/portouts/:id/:status");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/portouts/:id/:status")
require "http/client"
url = "{{baseUrl}}/portouts/:id/:status"
response = HTTP::Client.patch url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/portouts/:id/:status"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/portouts/:id/:status");
var request = new RestRequest("", Method.Patch);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/portouts/:id/:status"
req, _ := http.NewRequest("PATCH", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PATCH /baseUrl/portouts/:id/:status HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/portouts/:id/:status")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/portouts/:id/:status"))
.method("PATCH", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/portouts/:id/:status")
.patch(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/portouts/:id/:status")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/portouts/:id/:status');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PATCH', url: '{{baseUrl}}/portouts/:id/:status'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/portouts/:id/:status';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/portouts/:id/:status',
method: 'PATCH',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/portouts/:id/:status")
.patch(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/portouts/:id/:status',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'PATCH', url: '{{baseUrl}}/portouts/:id/:status'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/portouts/:id/:status');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'PATCH', url: '{{baseUrl}}/portouts/:id/:status'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/portouts/:id/:status';
const options = {method: 'PATCH'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/portouts/:id/:status"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/portouts/:id/:status" in
Client.call `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/portouts/:id/:status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PATCH', '{{baseUrl}}/portouts/:id/:status');
echo $response->getBody();
setUrl('{{baseUrl}}/portouts/:id/:status');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/portouts/:id/:status');
$request->setRequestMethod('PATCH');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/portouts/:id/:status' -Method PATCH
$response = Invoke-RestMethod -Uri '{{baseUrl}}/portouts/:id/:status' -Method PATCH
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PATCH", "/baseUrl/portouts/:id/:status")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/portouts/:id/:status"
response = requests.patch(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/portouts/:id/:status"
response <- VERB("PATCH", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/portouts/:id/:status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.patch('/baseUrl/portouts/:id/:status') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/portouts/:id/:status";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/portouts/:id/:status
http PATCH {{baseUrl}}/portouts/:id/:status
wget --quiet \
--method PATCH \
--output-document \
- {{baseUrl}}/portouts/:id/:status
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/portouts/:id/:status")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"carrier_name": "test",
"created_at": "2018-02-02T22:25:27.521Z",
"foc_date": "2018-02-02T22:25:27.521Z",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"phone_numbers": [
"+35312345678"
],
"record_type": "portout",
"requested_foc_date": "2018-02-02T22:25:27.521Z",
"spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"status": "pending",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Create a number reservation
{{baseUrl}}/number_reservations
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_reservations");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/number_reservations")
require "http/client"
url = "{{baseUrl}}/number_reservations"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/number_reservations"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_reservations");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_reservations"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/number_reservations HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/number_reservations")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_reservations"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_reservations")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/number_reservations")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/number_reservations');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/number_reservations'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_reservations';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_reservations',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_reservations")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_reservations',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/number_reservations'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/number_reservations');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/number_reservations'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_reservations';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_reservations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_reservations" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_reservations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/number_reservations');
echo $response->getBody();
setUrl('{{baseUrl}}/number_reservations');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_reservations');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_reservations' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_reservations' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/number_reservations", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_reservations"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_reservations"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_reservations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/number_reservations') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_reservations";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/number_reservations
http POST {{baseUrl}}/number_reservations
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/number_reservations
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_reservations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"created_at": "2018-01-01T00:00:00.000000Z",
"errors": "",
"expired_at": "2018-01-01T00:00:00.000000Z",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+19705555098",
"record_type": "reserved_phone_number",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
],
"record_type": "number_reservation",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
}
POST
Extend a number reservation
{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend
QUERY PARAMS
number_reservation_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend")
require "http/client"
url = "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/number_reservations/:number_reservation_id/actions/extend HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_reservations/:number_reservation_id/actions/extend',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend');
echo $response->getBody();
setUrl('{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/number_reservations/:number_reservation_id/actions/extend")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/number_reservations/:number_reservation_id/actions/extend') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/number_reservations/:number_reservation_id/actions/extend
http POST {{baseUrl}}/number_reservations/:number_reservation_id/actions/extend
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/number_reservations/:number_reservation_id/actions/extend
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_reservations/:number_reservation_id/actions/extend")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"created_at": "2018-01-01T00:00:00.000000Z",
"errors": "",
"expired_at": "2018-01-01T00:00:00.000000Z",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+19705555098",
"record_type": "reserved_phone_number",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
],
"record_type": "number_reservation",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
}
GET
List number reservations
{{baseUrl}}/number_reservations
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_reservations");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_reservations")
require "http/client"
url = "{{baseUrl}}/number_reservations"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_reservations"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_reservations");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_reservations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_reservations HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_reservations")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_reservations"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_reservations")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_reservations")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_reservations');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/number_reservations'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_reservations';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_reservations',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_reservations")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_reservations',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/number_reservations'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_reservations');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/number_reservations'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_reservations';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_reservations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_reservations" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_reservations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_reservations');
echo $response->getBody();
setUrl('{{baseUrl}}/number_reservations');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_reservations');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_reservations' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_reservations' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_reservations")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_reservations"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_reservations"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_reservations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_reservations') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_reservations";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_reservations
http GET {{baseUrl}}/number_reservations
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_reservations
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_reservations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"created_at": "2018-01-01T00:00:00.000000Z",
"errors": "",
"expired_at": "2018-01-01T00:00:00.000000Z",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+19705555098",
"record_type": "reserved_phone_number",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
],
"record_type": "number_reservation",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a number reservation
{{baseUrl}}/number_reservations/:number_reservation_id
QUERY PARAMS
number_reservation_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/number_reservations/:number_reservation_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/number_reservations/:number_reservation_id")
require "http/client"
url = "{{baseUrl}}/number_reservations/:number_reservation_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/number_reservations/:number_reservation_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/number_reservations/:number_reservation_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/number_reservations/:number_reservation_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/number_reservations/:number_reservation_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/number_reservations/:number_reservation_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/number_reservations/:number_reservation_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/number_reservations/:number_reservation_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/number_reservations/:number_reservation_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/number_reservations/:number_reservation_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/number_reservations/:number_reservation_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/number_reservations/:number_reservation_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/number_reservations/:number_reservation_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/number_reservations/:number_reservation_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/number_reservations/:number_reservation_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/number_reservations/:number_reservation_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/number_reservations/:number_reservation_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/number_reservations/:number_reservation_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/number_reservations/:number_reservation_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/number_reservations/:number_reservation_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/number_reservations/:number_reservation_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/number_reservations/:number_reservation_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/number_reservations/:number_reservation_id');
echo $response->getBody();
setUrl('{{baseUrl}}/number_reservations/:number_reservation_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/number_reservations/:number_reservation_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/number_reservations/:number_reservation_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/number_reservations/:number_reservation_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/number_reservations/:number_reservation_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/number_reservations/:number_reservation_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/number_reservations/:number_reservation_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/number_reservations/:number_reservation_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/number_reservations/:number_reservation_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/number_reservations/:number_reservation_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/number_reservations/:number_reservation_id
http GET {{baseUrl}}/number_reservations/:number_reservation_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/number_reservations/:number_reservation_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/number_reservations/:number_reservation_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-01-01T00:00:00.000000Z",
"customer_reference": "MY REF 001",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_numbers": [
{
"created_at": "2018-01-01T00:00:00.000000Z",
"errors": "",
"expired_at": "2018-01-01T00:00:00.000000Z",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+19705555098",
"record_type": "reserved_phone_number",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
],
"record_type": "number_reservation",
"status": "pending",
"updated_at": "2018-01-01T00:00:00.000000Z"
}
}
GET
List available phone number blocks
{{baseUrl}}/available_phone_number_blocks
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/available_phone_number_blocks");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/available_phone_number_blocks")
require "http/client"
url = "{{baseUrl}}/available_phone_number_blocks"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/available_phone_number_blocks"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/available_phone_number_blocks");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/available_phone_number_blocks"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/available_phone_number_blocks HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/available_phone_number_blocks")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/available_phone_number_blocks"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/available_phone_number_blocks")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/available_phone_number_blocks")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/available_phone_number_blocks');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/available_phone_number_blocks'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/available_phone_number_blocks';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/available_phone_number_blocks',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/available_phone_number_blocks")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/available_phone_number_blocks',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/available_phone_number_blocks'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/available_phone_number_blocks');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/available_phone_number_blocks'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/available_phone_number_blocks';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/available_phone_number_blocks"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/available_phone_number_blocks" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/available_phone_number_blocks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/available_phone_number_blocks');
echo $response->getBody();
setUrl('{{baseUrl}}/available_phone_number_blocks');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/available_phone_number_blocks');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/available_phone_number_blocks' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/available_phone_number_blocks' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/available_phone_number_blocks")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/available_phone_number_blocks"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/available_phone_number_blocks"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/available_phone_number_blocks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/available_phone_number_blocks') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/available_phone_number_blocks";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/available_phone_number_blocks
http GET {{baseUrl}}/available_phone_number_blocks
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/available_phone_number_blocks
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/available_phone_number_blocks")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"cost_information": {
"currency": "USD",
"monthly_cost": "6.54",
"upfront_cost": "3.21"
},
"features": [
{
"name": "sms"
},
{
"name": "voice"
}
],
"phone_number": "+19705555000",
"range": 10,
"record_type": "available_phone_number_block",
"region_information": [
{
"region_name": "US",
"region_type": "country_code"
}
]
}
],
"meta": {
"best_effort_results": 50,
"total_results": 100
}
}
GET
List available phone numbers
{{baseUrl}}/available_phone_numbers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/available_phone_numbers");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/available_phone_numbers")
require "http/client"
url = "{{baseUrl}}/available_phone_numbers"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/available_phone_numbers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/available_phone_numbers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/available_phone_numbers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/available_phone_numbers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/available_phone_numbers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/available_phone_numbers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/available_phone_numbers")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/available_phone_numbers")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/available_phone_numbers');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/available_phone_numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/available_phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/available_phone_numbers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/available_phone_numbers")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/available_phone_numbers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/available_phone_numbers'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/available_phone_numbers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/available_phone_numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/available_phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/available_phone_numbers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/available_phone_numbers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/available_phone_numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/available_phone_numbers');
echo $response->getBody();
setUrl('{{baseUrl}}/available_phone_numbers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/available_phone_numbers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/available_phone_numbers' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/available_phone_numbers' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/available_phone_numbers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/available_phone_numbers"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/available_phone_numbers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/available_phone_numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/available_phone_numbers') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/available_phone_numbers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/available_phone_numbers
http GET {{baseUrl}}/available_phone_numbers
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/available_phone_numbers
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/available_phone_numbers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"best_effort": false,
"cost_information": {
"currency": "USD",
"monthly_cost": "6.54",
"upfront_cost": "3.21"
},
"features": [
{
"name": "sms"
},
{
"name": "voice"
}
],
"phone_number": "+19705555098",
"quickship": true,
"record_type": "available_phone_number",
"region_information": [
{
"region_name": "US",
"region_type": "country_code"
}
],
"reservable": true,
"vanity_format": ""
}
],
"meta": {
"best_effort_results": 50,
"total_results": 100
}
}
GET
Get OTA update
{{baseUrl}}/ota_updates/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ota_updates/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/ota_updates/:id")
require "http/client"
url = "{{baseUrl}}/ota_updates/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/ota_updates/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ota_updates/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ota_updates/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/ota_updates/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/ota_updates/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ota_updates/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ota_updates/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/ota_updates/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/ota_updates/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/ota_updates/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ota_updates/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ota_updates/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ota_updates/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/ota_updates/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/ota_updates/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/ota_updates/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/ota_updates/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ota_updates/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ota_updates/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ota_updates/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ota_updates/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/ota_updates/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/ota_updates/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ota_updates/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ota_updates/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ota_updates/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/ota_updates/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ota_updates/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ota_updates/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ota_updates/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/ota_updates/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ota_updates/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/ota_updates/:id
http GET {{baseUrl}}/ota_updates/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/ota_updates/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ota_updates/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "ota_update",
"settings": {
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"mobile_operator_network_name": "AT&T Mobility (USACG)",
"priority": 0
}
]
},
"sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "in-progress",
"type": "sim_card_network_preferences",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
List OTA updates
{{baseUrl}}/ota_updates
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ota_updates");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/ota_updates")
require "http/client"
url = "{{baseUrl}}/ota_updates"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/ota_updates"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ota_updates");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ota_updates"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/ota_updates HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/ota_updates")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ota_updates"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ota_updates")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/ota_updates")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/ota_updates');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/ota_updates'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ota_updates';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ota_updates',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ota_updates")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/ota_updates',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/ota_updates'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/ota_updates');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/ota_updates'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ota_updates';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ota_updates"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ota_updates" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ota_updates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/ota_updates');
echo $response->getBody();
setUrl('{{baseUrl}}/ota_updates');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ota_updates');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ota_updates' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ota_updates' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/ota_updates")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ota_updates"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ota_updates"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ota_updates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/ota_updates') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ota_updates";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/ota_updates
http GET {{baseUrl}}/ota_updates
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/ota_updates
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ota_updates")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Create an outbound voice profile
{{baseUrl}}/outbound_voice_profiles
BODY json
{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/outbound_voice_profiles");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/outbound_voice_profiles" {:content-type :json
:form-params {:billing_group_id ""
:call_recording {:call_recording_caller_phone_numbers []
:call_recording_channels ""
:call_recording_format ""
:call_recording_type ""}
:concurrent_call_limit 0
:daily_spend_limit ""
:daily_spend_limit_enabled false
:enabled false
:max_destination_rate ""
:name ""
:service_plan ""
:tags []
:traffic_type ""
:usage_payment_method ""
:whitelisted_destinations []}})
require "http/client"
url = "{{baseUrl}}/outbound_voice_profiles"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/outbound_voice_profiles"),
Content = new StringContent("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/outbound_voice_profiles");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/outbound_voice_profiles"
payload := strings.NewReader("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\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(res)
fmt.Println(string(body))
}
POST /baseUrl/outbound_voice_profiles HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 481
{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/outbound_voice_profiles")
.setHeader("content-type", "application/json")
.setBody("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/outbound_voice_profiles"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/outbound_voice_profiles")
.header("content-type", "application/json")
.body("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
.asString();
const data = JSON.stringify({
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/outbound_voice_profiles');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/outbound_voice_profiles',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/outbound_voice_profiles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","call_recording":{"call_recording_caller_phone_numbers":[],"call_recording_channels":"","call_recording_format":"","call_recording_type":""},"concurrent_call_limit":0,"daily_spend_limit":"","daily_spend_limit_enabled":false,"enabled":false,"max_destination_rate":"","name":"","service_plan":"","tags":[],"traffic_type":"","usage_payment_method":"","whitelisted_destinations":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/outbound_voice_profiles',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "billing_group_id": "",\n "call_recording": {\n "call_recording_caller_phone_numbers": [],\n "call_recording_channels": "",\n "call_recording_format": "",\n "call_recording_type": ""\n },\n "concurrent_call_limit": 0,\n "daily_spend_limit": "",\n "daily_spend_limit_enabled": false,\n "enabled": false,\n "max_destination_rate": "",\n "name": "",\n "service_plan": "",\n "tags": [],\n "traffic_type": "",\n "usage_payment_method": "",\n "whitelisted_destinations": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/outbound_voice_profiles',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/outbound_voice_profiles',
headers: {'content-type': 'application/json'},
body: {
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/outbound_voice_profiles');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/outbound_voice_profiles',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/outbound_voice_profiles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","call_recording":{"call_recording_caller_phone_numbers":[],"call_recording_channels":"","call_recording_format":"","call_recording_type":""},"concurrent_call_limit":0,"daily_spend_limit":"","daily_spend_limit_enabled":false,"enabled":false,"max_destination_rate":"","name":"","service_plan":"","tags":[],"traffic_type":"","usage_payment_method":"","whitelisted_destinations":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"billing_group_id": @"",
@"call_recording": @{ @"call_recording_caller_phone_numbers": @[ ], @"call_recording_channels": @"", @"call_recording_format": @"", @"call_recording_type": @"" },
@"concurrent_call_limit": @0,
@"daily_spend_limit": @"",
@"daily_spend_limit_enabled": @NO,
@"enabled": @NO,
@"max_destination_rate": @"",
@"name": @"",
@"service_plan": @"",
@"tags": @[ ],
@"traffic_type": @"",
@"usage_payment_method": @"",
@"whitelisted_destinations": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/outbound_voice_profiles"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/outbound_voice_profiles" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/outbound_voice_profiles",
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([
'billing_group_id' => '',
'call_recording' => [
'call_recording_caller_phone_numbers' => [
],
'call_recording_channels' => '',
'call_recording_format' => '',
'call_recording_type' => ''
],
'concurrent_call_limit' => 0,
'daily_spend_limit' => '',
'daily_spend_limit_enabled' => null,
'enabled' => null,
'max_destination_rate' => '',
'name' => '',
'service_plan' => '',
'tags' => [
],
'traffic_type' => '',
'usage_payment_method' => '',
'whitelisted_destinations' => [
]
]),
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;
}
request('POST', '{{baseUrl}}/outbound_voice_profiles', [
'body' => '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/outbound_voice_profiles');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'billing_group_id' => '',
'call_recording' => [
'call_recording_caller_phone_numbers' => [
],
'call_recording_channels' => '',
'call_recording_format' => '',
'call_recording_type' => ''
],
'concurrent_call_limit' => 0,
'daily_spend_limit' => '',
'daily_spend_limit_enabled' => null,
'enabled' => null,
'max_destination_rate' => '',
'name' => '',
'service_plan' => '',
'tags' => [
],
'traffic_type' => '',
'usage_payment_method' => '',
'whitelisted_destinations' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'billing_group_id' => '',
'call_recording' => [
'call_recording_caller_phone_numbers' => [
],
'call_recording_channels' => '',
'call_recording_format' => '',
'call_recording_type' => ''
],
'concurrent_call_limit' => 0,
'daily_spend_limit' => '',
'daily_spend_limit_enabled' => null,
'enabled' => null,
'max_destination_rate' => '',
'name' => '',
'service_plan' => '',
'tags' => [
],
'traffic_type' => '',
'usage_payment_method' => '',
'whitelisted_destinations' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/outbound_voice_profiles');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/outbound_voice_profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/outbound_voice_profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/outbound_voice_profiles", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/outbound_voice_profiles"
payload = {
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": False,
"enabled": False,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/outbound_voice_profiles"
payload <- "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/outbound_voice_profiles")
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 \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/outbound_voice_profiles') do |req|
req.body = "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/outbound_voice_profiles";
let payload = json!({
"billing_group_id": "",
"call_recording": json!({
"call_recording_caller_phone_numbers": (),
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
}),
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": (),
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/outbound_voice_profiles \
--header 'content-type: application/json' \
--data '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}'
echo '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}' | \
http POST {{baseUrl}}/outbound_voice_profiles \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "billing_group_id": "",\n "call_recording": {\n "call_recording_caller_phone_numbers": [],\n "call_recording_channels": "",\n "call_recording_format": "",\n "call_recording_type": ""\n },\n "concurrent_call_limit": 0,\n "daily_spend_limit": "",\n "daily_spend_limit_enabled": false,\n "enabled": false,\n "max_destination_rate": "",\n "name": "",\n "service_plan": "",\n "tags": [],\n "traffic_type": "",\n "usage_payment_method": "",\n "whitelisted_destinations": []\n}' \
--output-document \
- {{baseUrl}}/outbound_voice_profiles
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"billing_group_id": "",
"call_recording": [
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
],
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/outbound_voice_profiles")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"call_recording": {
"call_recording_caller_phone_numbers": [
"+19705555098"
],
"call_recording_channels": "dual",
"call_recording_format": "mp3",
"call_recording_type": "by_caller_phone_number"
},
"concurrent_call_limit": 10,
"connections_count": 12,
"created_at": "2018-02-02T22:25:27.521Z",
"daily_spend_limit": "100.00",
"daily_spend_limit_enabled": true,
"enabled": true,
"id": "1293384261075731499",
"max_destination_rate": 10,
"name": "office",
"record_type": "outbound_voice_profile",
"service_plan": "global",
"tags": [
"office-profile"
],
"traffic_type": "conversational",
"updated_at": "2018-02-02T22:25:27.521Z",
"usage_payment_method": "rate-deck",
"whitelisted_destinations": [
"US",
"BR",
"AU"
]
}
}
DELETE
Delete an outbound voice profile
{{baseUrl}}/outbound_voice_profiles/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/outbound_voice_profiles/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/outbound_voice_profiles/:id")
require "http/client"
url = "{{baseUrl}}/outbound_voice_profiles/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/outbound_voice_profiles/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/outbound_voice_profiles/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/outbound_voice_profiles/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/outbound_voice_profiles/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/outbound_voice_profiles/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/outbound_voice_profiles/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/outbound_voice_profiles/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/outbound_voice_profiles/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/outbound_voice_profiles/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/outbound_voice_profiles/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/outbound_voice_profiles/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/outbound_voice_profiles/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/outbound_voice_profiles/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/outbound_voice_profiles/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/outbound_voice_profiles/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/outbound_voice_profiles/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/outbound_voice_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/outbound_voice_profiles/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/outbound_voice_profiles/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/outbound_voice_profiles/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/outbound_voice_profiles/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/outbound_voice_profiles/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/outbound_voice_profiles/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/outbound_voice_profiles/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/outbound_voice_profiles/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/outbound_voice_profiles/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/outbound_voice_profiles/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/outbound_voice_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/outbound_voice_profiles/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/outbound_voice_profiles/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/outbound_voice_profiles/:id
http DELETE {{baseUrl}}/outbound_voice_profiles/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/outbound_voice_profiles/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/outbound_voice_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"call_recording": {
"call_recording_caller_phone_numbers": [
"+19705555098"
],
"call_recording_channels": "dual",
"call_recording_format": "mp3",
"call_recording_type": "by_caller_phone_number"
},
"concurrent_call_limit": 10,
"connections_count": 12,
"created_at": "2018-02-02T22:25:27.521Z",
"daily_spend_limit": "100.00",
"daily_spend_limit_enabled": true,
"enabled": true,
"id": "1293384261075731499",
"max_destination_rate": 10,
"name": "office",
"record_type": "outbound_voice_profile",
"service_plan": "global",
"tags": [
"office-profile"
],
"traffic_type": "conversational",
"updated_at": "2018-02-02T22:25:27.521Z",
"usage_payment_method": "rate-deck",
"whitelisted_destinations": [
"US",
"BR",
"AU"
]
}
}
GET
Get all outbound voice profiles
{{baseUrl}}/outbound_voice_profiles
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/outbound_voice_profiles");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/outbound_voice_profiles")
require "http/client"
url = "{{baseUrl}}/outbound_voice_profiles"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/outbound_voice_profiles"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/outbound_voice_profiles");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/outbound_voice_profiles"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/outbound_voice_profiles HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/outbound_voice_profiles")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/outbound_voice_profiles"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/outbound_voice_profiles")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/outbound_voice_profiles');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/outbound_voice_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/outbound_voice_profiles';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/outbound_voice_profiles',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/outbound_voice_profiles',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/outbound_voice_profiles'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/outbound_voice_profiles');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/outbound_voice_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/outbound_voice_profiles';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/outbound_voice_profiles"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/outbound_voice_profiles" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/outbound_voice_profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/outbound_voice_profiles');
echo $response->getBody();
setUrl('{{baseUrl}}/outbound_voice_profiles');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/outbound_voice_profiles');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/outbound_voice_profiles' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/outbound_voice_profiles' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/outbound_voice_profiles")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/outbound_voice_profiles"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/outbound_voice_profiles"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/outbound_voice_profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/outbound_voice_profiles') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/outbound_voice_profiles";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/outbound_voice_profiles
http GET {{baseUrl}}/outbound_voice_profiles
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/outbound_voice_profiles
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/outbound_voice_profiles")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"call_recording": {
"call_recording_caller_phone_numbers": [
"+19705555098"
],
"call_recording_channels": "dual",
"call_recording_format": "mp3",
"call_recording_type": "by_caller_phone_number"
},
"concurrent_call_limit": 10,
"connections_count": 12,
"created_at": "2018-02-02T22:25:27.521Z",
"daily_spend_limit": "100.00",
"daily_spend_limit_enabled": true,
"enabled": true,
"id": "1293384261075731499",
"max_destination_rate": 10,
"name": "office",
"record_type": "outbound_voice_profile",
"service_plan": "global",
"tags": [
"office-profile"
],
"traffic_type": "conversational",
"updated_at": "2018-02-02T22:25:27.521Z",
"usage_payment_method": "rate-deck",
"whitelisted_destinations": [
"US",
"BR",
"AU"
]
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve an outbound voice profile
{{baseUrl}}/outbound_voice_profiles/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/outbound_voice_profiles/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/outbound_voice_profiles/:id")
require "http/client"
url = "{{baseUrl}}/outbound_voice_profiles/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/outbound_voice_profiles/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/outbound_voice_profiles/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/outbound_voice_profiles/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/outbound_voice_profiles/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/outbound_voice_profiles/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/outbound_voice_profiles/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/outbound_voice_profiles/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/outbound_voice_profiles/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/outbound_voice_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/outbound_voice_profiles/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/outbound_voice_profiles/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/outbound_voice_profiles/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/outbound_voice_profiles/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/outbound_voice_profiles/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/outbound_voice_profiles/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/outbound_voice_profiles/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/outbound_voice_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/outbound_voice_profiles/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/outbound_voice_profiles/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/outbound_voice_profiles/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/outbound_voice_profiles/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/outbound_voice_profiles/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/outbound_voice_profiles/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/outbound_voice_profiles/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/outbound_voice_profiles/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/outbound_voice_profiles/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/outbound_voice_profiles/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/outbound_voice_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/outbound_voice_profiles/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/outbound_voice_profiles/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/outbound_voice_profiles/:id
http GET {{baseUrl}}/outbound_voice_profiles/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/outbound_voice_profiles/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/outbound_voice_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"call_recording": {
"call_recording_caller_phone_numbers": [
"+19705555098"
],
"call_recording_channels": "dual",
"call_recording_format": "mp3",
"call_recording_type": "by_caller_phone_number"
},
"concurrent_call_limit": 10,
"connections_count": 12,
"created_at": "2018-02-02T22:25:27.521Z",
"daily_spend_limit": "100.00",
"daily_spend_limit_enabled": true,
"enabled": true,
"id": "1293384261075731499",
"max_destination_rate": 10,
"name": "office",
"record_type": "outbound_voice_profile",
"service_plan": "global",
"tags": [
"office-profile"
],
"traffic_type": "conversational",
"updated_at": "2018-02-02T22:25:27.521Z",
"usage_payment_method": "rate-deck",
"whitelisted_destinations": [
"US",
"BR",
"AU"
]
}
}
PATCH
Updates an existing outbound voice profile.
{{baseUrl}}/outbound_voice_profiles/:id
QUERY PARAMS
id
BODY json
{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/outbound_voice_profiles/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/outbound_voice_profiles/:id" {:content-type :json
:form-params {:billing_group_id ""
:call_recording {:call_recording_caller_phone_numbers []
:call_recording_channels ""
:call_recording_format ""
:call_recording_type ""}
:concurrent_call_limit 0
:daily_spend_limit ""
:daily_spend_limit_enabled false
:enabled false
:max_destination_rate ""
:name ""
:service_plan ""
:tags []
:traffic_type ""
:usage_payment_method ""
:whitelisted_destinations []}})
require "http/client"
url = "{{baseUrl}}/outbound_voice_profiles/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/outbound_voice_profiles/:id"),
Content = new StringContent("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/outbound_voice_profiles/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/outbound_voice_profiles/:id"
payload := strings.NewReader("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/outbound_voice_profiles/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 481
{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/outbound_voice_profiles/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/outbound_voice_profiles/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/outbound_voice_profiles/:id")
.header("content-type", "application/json")
.body("{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
.asString();
const data = JSON.stringify({
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/outbound_voice_profiles/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/outbound_voice_profiles/:id',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/outbound_voice_profiles/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","call_recording":{"call_recording_caller_phone_numbers":[],"call_recording_channels":"","call_recording_format":"","call_recording_type":""},"concurrent_call_limit":0,"daily_spend_limit":"","daily_spend_limit_enabled":false,"enabled":false,"max_destination_rate":"","name":"","service_plan":"","tags":[],"traffic_type":"","usage_payment_method":"","whitelisted_destinations":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/outbound_voice_profiles/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "billing_group_id": "",\n "call_recording": {\n "call_recording_caller_phone_numbers": [],\n "call_recording_channels": "",\n "call_recording_format": "",\n "call_recording_type": ""\n },\n "concurrent_call_limit": 0,\n "daily_spend_limit": "",\n "daily_spend_limit_enabled": false,\n "enabled": false,\n "max_destination_rate": "",\n "name": "",\n "service_plan": "",\n "tags": [],\n "traffic_type": "",\n "usage_payment_method": "",\n "whitelisted_destinations": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/outbound_voice_profiles/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/outbound_voice_profiles/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/outbound_voice_profiles/:id',
headers: {'content-type': 'application/json'},
body: {
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/outbound_voice_profiles/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/outbound_voice_profiles/:id',
headers: {'content-type': 'application/json'},
data: {
billing_group_id: '',
call_recording: {
call_recording_caller_phone_numbers: [],
call_recording_channels: '',
call_recording_format: '',
call_recording_type: ''
},
concurrent_call_limit: 0,
daily_spend_limit: '',
daily_spend_limit_enabled: false,
enabled: false,
max_destination_rate: '',
name: '',
service_plan: '',
tags: [],
traffic_type: '',
usage_payment_method: '',
whitelisted_destinations: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/outbound_voice_profiles/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"billing_group_id":"","call_recording":{"call_recording_caller_phone_numbers":[],"call_recording_channels":"","call_recording_format":"","call_recording_type":""},"concurrent_call_limit":0,"daily_spend_limit":"","daily_spend_limit_enabled":false,"enabled":false,"max_destination_rate":"","name":"","service_plan":"","tags":[],"traffic_type":"","usage_payment_method":"","whitelisted_destinations":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"billing_group_id": @"",
@"call_recording": @{ @"call_recording_caller_phone_numbers": @[ ], @"call_recording_channels": @"", @"call_recording_format": @"", @"call_recording_type": @"" },
@"concurrent_call_limit": @0,
@"daily_spend_limit": @"",
@"daily_spend_limit_enabled": @NO,
@"enabled": @NO,
@"max_destination_rate": @"",
@"name": @"",
@"service_plan": @"",
@"tags": @[ ],
@"traffic_type": @"",
@"usage_payment_method": @"",
@"whitelisted_destinations": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/outbound_voice_profiles/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/outbound_voice_profiles/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/outbound_voice_profiles/:id",
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([
'billing_group_id' => '',
'call_recording' => [
'call_recording_caller_phone_numbers' => [
],
'call_recording_channels' => '',
'call_recording_format' => '',
'call_recording_type' => ''
],
'concurrent_call_limit' => 0,
'daily_spend_limit' => '',
'daily_spend_limit_enabled' => null,
'enabled' => null,
'max_destination_rate' => '',
'name' => '',
'service_plan' => '',
'tags' => [
],
'traffic_type' => '',
'usage_payment_method' => '',
'whitelisted_destinations' => [
]
]),
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;
}
request('PATCH', '{{baseUrl}}/outbound_voice_profiles/:id', [
'body' => '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/outbound_voice_profiles/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'billing_group_id' => '',
'call_recording' => [
'call_recording_caller_phone_numbers' => [
],
'call_recording_channels' => '',
'call_recording_format' => '',
'call_recording_type' => ''
],
'concurrent_call_limit' => 0,
'daily_spend_limit' => '',
'daily_spend_limit_enabled' => null,
'enabled' => null,
'max_destination_rate' => '',
'name' => '',
'service_plan' => '',
'tags' => [
],
'traffic_type' => '',
'usage_payment_method' => '',
'whitelisted_destinations' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'billing_group_id' => '',
'call_recording' => [
'call_recording_caller_phone_numbers' => [
],
'call_recording_channels' => '',
'call_recording_format' => '',
'call_recording_type' => ''
],
'concurrent_call_limit' => 0,
'daily_spend_limit' => '',
'daily_spend_limit_enabled' => null,
'enabled' => null,
'max_destination_rate' => '',
'name' => '',
'service_plan' => '',
'tags' => [
],
'traffic_type' => '',
'usage_payment_method' => '',
'whitelisted_destinations' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/outbound_voice_profiles/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/outbound_voice_profiles/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/outbound_voice_profiles/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/outbound_voice_profiles/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/outbound_voice_profiles/:id"
payload = {
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": False,
"enabled": False,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/outbound_voice_profiles/:id"
payload <- "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/outbound_voice_profiles/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/outbound_voice_profiles/:id') do |req|
req.body = "{\n \"billing_group_id\": \"\",\n \"call_recording\": {\n \"call_recording_caller_phone_numbers\": [],\n \"call_recording_channels\": \"\",\n \"call_recording_format\": \"\",\n \"call_recording_type\": \"\"\n },\n \"concurrent_call_limit\": 0,\n \"daily_spend_limit\": \"\",\n \"daily_spend_limit_enabled\": false,\n \"enabled\": false,\n \"max_destination_rate\": \"\",\n \"name\": \"\",\n \"service_plan\": \"\",\n \"tags\": [],\n \"traffic_type\": \"\",\n \"usage_payment_method\": \"\",\n \"whitelisted_destinations\": []\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/outbound_voice_profiles/:id";
let payload = json!({
"billing_group_id": "",
"call_recording": json!({
"call_recording_caller_phone_numbers": (),
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
}),
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": (),
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/outbound_voice_profiles/:id \
--header 'content-type: application/json' \
--data '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}'
echo '{
"billing_group_id": "",
"call_recording": {
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
},
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
}' | \
http PATCH {{baseUrl}}/outbound_voice_profiles/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "billing_group_id": "",\n "call_recording": {\n "call_recording_caller_phone_numbers": [],\n "call_recording_channels": "",\n "call_recording_format": "",\n "call_recording_type": ""\n },\n "concurrent_call_limit": 0,\n "daily_spend_limit": "",\n "daily_spend_limit_enabled": false,\n "enabled": false,\n "max_destination_rate": "",\n "name": "",\n "service_plan": "",\n "tags": [],\n "traffic_type": "",\n "usage_payment_method": "",\n "whitelisted_destinations": []\n}' \
--output-document \
- {{baseUrl}}/outbound_voice_profiles/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"billing_group_id": "",
"call_recording": [
"call_recording_caller_phone_numbers": [],
"call_recording_channels": "",
"call_recording_format": "",
"call_recording_type": ""
],
"concurrent_call_limit": 0,
"daily_spend_limit": "",
"daily_spend_limit_enabled": false,
"enabled": false,
"max_destination_rate": "",
"name": "",
"service_plan": "",
"tags": [],
"traffic_type": "",
"usage_payment_method": "",
"whitelisted_destinations": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/outbound_voice_profiles/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"call_recording": {
"call_recording_caller_phone_numbers": [
"+19705555098"
],
"call_recording_channels": "dual",
"call_recording_format": "mp3",
"call_recording_type": "by_caller_phone_number"
},
"concurrent_call_limit": 10,
"connections_count": 12,
"created_at": "2018-02-02T22:25:27.521Z",
"daily_spend_limit": "100.00",
"daily_spend_limit_enabled": true,
"enabled": true,
"id": "1293384261075731499",
"max_destination_rate": 10,
"name": "office",
"record_type": "outbound_voice_profile",
"service_plan": "global",
"tags": [
"office-profile"
],
"traffic_type": "conversational",
"updated_at": "2018-02-02T22:25:27.521Z",
"usage_payment_method": "rate-deck",
"whitelisted_destinations": [
"US",
"BR",
"AU"
]
}
}
POST
Run a portability check
{{baseUrl}}/portability_checks
BODY json
{
"phone_numbers": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/portability_checks");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/portability_checks" {:content-type :json
:form-params {:phone_numbers ["+13035550000" "+13035550001" "+13035550002"]}})
require "http/client"
url = "{{baseUrl}}/portability_checks"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/portability_checks"),
Content = new StringContent("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/portability_checks");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/portability_checks"
payload := strings.NewReader("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\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(res)
fmt.Println(string(body))
}
POST /baseUrl/portability_checks HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 87
{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/portability_checks")
.setHeader("content-type", "application/json")
.setBody("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/portability_checks"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/portability_checks")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/portability_checks")
.header("content-type", "application/json")
.body("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}")
.asString();
const data = JSON.stringify({
phone_numbers: [
'+13035550000',
'+13035550001',
'+13035550002'
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/portability_checks');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/portability_checks',
headers: {'content-type': 'application/json'},
data: {phone_numbers: ['+13035550000', '+13035550001', '+13035550002']}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/portability_checks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_numbers":["+13035550000","+13035550001","+13035550002"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/portability_checks',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "phone_numbers": [\n "+13035550000",\n "+13035550001",\n "+13035550002"\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/portability_checks")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/portability_checks',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({phone_numbers: ['+13035550000', '+13035550001', '+13035550002']}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/portability_checks',
headers: {'content-type': 'application/json'},
body: {phone_numbers: ['+13035550000', '+13035550001', '+13035550002']},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/portability_checks');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
phone_numbers: [
'+13035550000',
'+13035550001',
'+13035550002'
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/portability_checks',
headers: {'content-type': 'application/json'},
data: {phone_numbers: ['+13035550000', '+13035550001', '+13035550002']}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/portability_checks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_numbers":["+13035550000","+13035550001","+13035550002"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"phone_numbers": @[ @"+13035550000", @"+13035550001", @"+13035550002" ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/portability_checks"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/portability_checks" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/portability_checks",
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([
'phone_numbers' => [
'+13035550000',
'+13035550001',
'+13035550002'
]
]),
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;
}
request('POST', '{{baseUrl}}/portability_checks', [
'body' => '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/portability_checks');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'phone_numbers' => [
'+13035550000',
'+13035550001',
'+13035550002'
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'phone_numbers' => [
'+13035550000',
'+13035550001',
'+13035550002'
]
]));
$request->setRequestUrl('{{baseUrl}}/portability_checks');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/portability_checks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/portability_checks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/portability_checks", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/portability_checks"
payload = { "phone_numbers": ["+13035550000", "+13035550001", "+13035550002"] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/portability_checks"
payload <- "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/portability_checks")
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 \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/portability_checks') do |req|
req.body = "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/portability_checks";
let payload = json!({"phone_numbers": ("+13035550000", "+13035550001", "+13035550002")});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/portability_checks \
--header 'content-type: application/json' \
--data '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}'
echo '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}' | \
http POST {{baseUrl}}/portability_checks \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "phone_numbers": [\n "+13035550000",\n "+13035550001",\n "+13035550002"\n ]\n}' \
--output-document \
- {{baseUrl}}/portability_checks
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["phone_numbers": ["+13035550000", "+13035550001", "+13035550002"]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/portability_checks")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Activates every number on a porting order.
{{baseUrl}}/porting_orders/:id/actions/activate
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id/actions/activate");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/porting_orders/:id/actions/activate")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id/actions/activate"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id/actions/activate"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id/actions/activate");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id/actions/activate"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/porting_orders/:id/actions/activate HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/porting_orders/:id/actions/activate")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id/actions/activate"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/actions/activate")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/porting_orders/:id/actions/activate")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/porting_orders/:id/actions/activate');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/activate'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id/actions/activate';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id/actions/activate',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/actions/activate")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id/actions/activate',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/activate'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/porting_orders/:id/actions/activate');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/activate'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id/actions/activate';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id/actions/activate"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id/actions/activate" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id/actions/activate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/porting_orders/:id/actions/activate');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id/actions/activate');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id/actions/activate');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id/actions/activate' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id/actions/activate' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/porting_orders/:id/actions/activate")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id/actions/activate"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id/actions/activate"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id/actions/activate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/porting_orders/:id/actions/activate') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id/actions/activate";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/porting_orders/:id/actions/activate
http POST {{baseUrl}}/porting_orders/:id/actions/activate
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/porting_orders/:id/actions/activate
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id/actions/activate")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2021-03-19T10:07:15.527Z",
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "porting_activation_job",
"updated_at": "2021-03-19T10:07:15.527Z"
}
}
POST
Cancel this porting order
{{baseUrl}}/porting_orders/:id/actions/cancel
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id/actions/cancel");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/porting_orders/:id/actions/cancel")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id/actions/cancel"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id/actions/cancel"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id/actions/cancel");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id/actions/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/porting_orders/:id/actions/cancel HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/porting_orders/:id/actions/cancel")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id/actions/cancel"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/actions/cancel")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/porting_orders/:id/actions/cancel")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/porting_orders/:id/actions/cancel');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/cancel'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id/actions/cancel';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id/actions/cancel',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/actions/cancel")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id/actions/cancel',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/cancel'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/porting_orders/:id/actions/cancel');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/cancel'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id/actions/cancel';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id/actions/cancel"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id/actions/cancel" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id/actions/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/porting_orders/:id/actions/cancel');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id/actions/cancel');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id/actions/cancel');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id/actions/cancel' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id/actions/cancel' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/porting_orders/:id/actions/cancel")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id/actions/cancel"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id/actions/cancel"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id/actions/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/porting_orders/:id/actions/cancel') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id/actions/cancel";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/porting_orders/:id/actions/cancel
http POST {{baseUrl}}/porting_orders/:id/actions/cancel
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/porting_orders/:id/actions/cancel
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id/actions/cancel")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2021-03-19T10:07:15.527Z",
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"old_service_provider_ocn": "Unreal Communications",
"porting_phone_numbers_count": 1,
"record_type": "porting_order",
"support_key": "123abc",
"updated_at": "2021-03-19T10:07:15.527Z",
"user_reference": "Acct 123abc",
"webhook_url": "https://example.com/porting_webhooks"
},
"meta": {
"phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
}
}
POST
Confirms the porting order is ready to be actioned.
{{baseUrl}}/porting_orders/:id/actions/confirm
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id/actions/confirm");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/porting_orders/:id/actions/confirm")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id/actions/confirm"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id/actions/confirm"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id/actions/confirm");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id/actions/confirm"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/porting_orders/:id/actions/confirm HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/porting_orders/:id/actions/confirm")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id/actions/confirm"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/actions/confirm")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/porting_orders/:id/actions/confirm")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/porting_orders/:id/actions/confirm');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/confirm'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id/actions/confirm';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id/actions/confirm',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/actions/confirm")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id/actions/confirm',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/confirm'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/porting_orders/:id/actions/confirm');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/actions/confirm'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id/actions/confirm';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id/actions/confirm"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id/actions/confirm" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id/actions/confirm",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/porting_orders/:id/actions/confirm');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id/actions/confirm');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id/actions/confirm');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id/actions/confirm' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id/actions/confirm' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/porting_orders/:id/actions/confirm")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id/actions/confirm"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id/actions/confirm"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id/actions/confirm")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/porting_orders/:id/actions/confirm') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id/actions/confirm";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/porting_orders/:id/actions/confirm
http POST {{baseUrl}}/porting_orders/:id/actions/confirm
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/porting_orders/:id/actions/confirm
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id/actions/confirm")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2021-03-19T10:07:15.527Z",
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"old_service_provider_ocn": "Unreal Communications",
"porting_phone_numbers_count": 1,
"record_type": "porting_order",
"support_key": "123abc",
"updated_at": "2021-03-19T10:07:15.527Z",
"user_reference": "Acct 123abc",
"webhook_url": "https://example.com/porting_webhooks"
},
"meta": {
"phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
}
}
POST
Create a comment for a porting order
{{baseUrl}}/porting_orders/:id/comments
QUERY PARAMS
id
BODY json
{
"body": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id/comments");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"body\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/porting_orders/:id/comments" {:content-type :json
:form-params {:body ""}})
require "http/client"
url = "{{baseUrl}}/porting_orders/:id/comments"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"body\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id/comments"),
Content = new StringContent("{\n \"body\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id/comments");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"body\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id/comments"
payload := strings.NewReader("{\n \"body\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/porting_orders/:id/comments HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 16
{
"body": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/porting_orders/:id/comments")
.setHeader("content-type", "application/json")
.setBody("{\n \"body\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id/comments"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"body\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"body\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/comments")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/porting_orders/:id/comments")
.header("content-type", "application/json")
.body("{\n \"body\": \"\"\n}")
.asString();
const data = JSON.stringify({
body: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/porting_orders/:id/comments');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/comments',
headers: {'content-type': 'application/json'},
data: {body: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id/comments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"body":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id/comments',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "body": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"body\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/comments")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id/comments',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({body: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/comments',
headers: {'content-type': 'application/json'},
body: {body: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/porting_orders/:id/comments');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
body: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders/:id/comments',
headers: {'content-type': 'application/json'},
data: {body: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id/comments';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"body":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"body": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id/comments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id/comments" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"body\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id/comments",
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([
'body' => ''
]),
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;
}
request('POST', '{{baseUrl}}/porting_orders/:id/comments', [
'body' => '{
"body": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id/comments');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'body' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'body' => ''
]));
$request->setRequestUrl('{{baseUrl}}/porting_orders/:id/comments');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id/comments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"body": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id/comments' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"body": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"body\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/porting_orders/:id/comments", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id/comments"
payload = { "body": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id/comments"
payload <- "{\n \"body\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id/comments")
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 \"body\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/porting_orders/:id/comments') do |req|
req.body = "{\n \"body\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id/comments";
let payload = json!({"body": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/porting_orders/:id/comments \
--header 'content-type: application/json' \
--data '{
"body": ""
}'
echo '{
"body": ""
}' | \
http POST {{baseUrl}}/porting_orders/:id/comments \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "body": ""\n}' \
--output-document \
- {{baseUrl}}/porting_orders/:id/comments
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["body": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id/comments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"body": "Great experience so far",
"created_at": "2021-03-19T10:07:15.527Z",
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "porting_comment",
"user_type": "user"
}
}
POST
Create a porting order
{{baseUrl}}/porting_orders
BODY json
{
"phone_numbers": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/porting_orders" {:content-type :json
:form-params {:phone_numbers ["+13035550000" "+13035550001" "+13035550002"]}})
require "http/client"
url = "{{baseUrl}}/porting_orders"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/porting_orders"),
Content = new StringContent("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders"
payload := strings.NewReader("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\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(res)
fmt.Println(string(body))
}
POST /baseUrl/porting_orders HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 87
{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/porting_orders")
.setHeader("content-type", "application/json")
.setBody("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/porting_orders")
.header("content-type", "application/json")
.body("{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}")
.asString();
const data = JSON.stringify({
phone_numbers: [
'+13035550000',
'+13035550001',
'+13035550002'
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/porting_orders');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders',
headers: {'content-type': 'application/json'},
data: {phone_numbers: ['+13035550000', '+13035550001', '+13035550002']}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_numbers":["+13035550000","+13035550001","+13035550002"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "phone_numbers": [\n "+13035550000",\n "+13035550001",\n "+13035550002"\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({phone_numbers: ['+13035550000', '+13035550001', '+13035550002']}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders',
headers: {'content-type': 'application/json'},
body: {phone_numbers: ['+13035550000', '+13035550001', '+13035550002']},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/porting_orders');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
phone_numbers: [
'+13035550000',
'+13035550001',
'+13035550002'
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/porting_orders',
headers: {'content-type': 'application/json'},
data: {phone_numbers: ['+13035550000', '+13035550001', '+13035550002']}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_numbers":["+13035550000","+13035550001","+13035550002"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"phone_numbers": @[ @"+13035550000", @"+13035550001", @"+13035550002" ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders",
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([
'phone_numbers' => [
'+13035550000',
'+13035550001',
'+13035550002'
]
]),
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;
}
request('POST', '{{baseUrl}}/porting_orders', [
'body' => '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'phone_numbers' => [
'+13035550000',
'+13035550001',
'+13035550002'
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'phone_numbers' => [
'+13035550000',
'+13035550001',
'+13035550002'
]
]));
$request->setRequestUrl('{{baseUrl}}/porting_orders');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/porting_orders", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders"
payload = { "phone_numbers": ["+13035550000", "+13035550001", "+13035550002"] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders"
payload <- "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders")
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 \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/porting_orders') do |req|
req.body = "{\n \"phone_numbers\": [\n \"+13035550000\",\n \"+13035550001\",\n \"+13035550002\"\n ]\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders";
let payload = json!({"phone_numbers": ("+13035550000", "+13035550001", "+13035550002")});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/porting_orders \
--header 'content-type: application/json' \
--data '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}'
echo '{
"phone_numbers": [
"+13035550000",
"+13035550001",
"+13035550002"
]
}' | \
http POST {{baseUrl}}/porting_orders \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "phone_numbers": [\n "+13035550000",\n "+13035550001",\n "+13035550002"\n ]\n}' \
--output-document \
- {{baseUrl}}/porting_orders
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["phone_numbers": ["+13035550000", "+13035550001", "+13035550002"]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download a porting order loa template
{{baseUrl}}/porting_orders/:id/loa_template
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id/loa_template");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/porting_orders/:id/loa_template")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id/loa_template"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id/loa_template"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id/loa_template");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id/loa_template"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/porting_orders/:id/loa_template HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/porting_orders/:id/loa_template")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id/loa_template"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/loa_template")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/porting_orders/:id/loa_template")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/porting_orders/:id/loa_template');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/loa_template'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id/loa_template';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id/loa_template',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/loa_template")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id/loa_template',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/loa_template'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/porting_orders/:id/loa_template');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/loa_template'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id/loa_template';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id/loa_template"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id/loa_template" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id/loa_template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/porting_orders/:id/loa_template');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id/loa_template');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id/loa_template');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id/loa_template' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id/loa_template' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/porting_orders/:id/loa_template")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id/loa_template"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id/loa_template"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id/loa_template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/porting_orders/:id/loa_template') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id/loa_template";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/porting_orders/:id/loa_template
http GET {{baseUrl}}/porting_orders/:id/loa_template
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/porting_orders/:id/loa_template
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id/loa_template")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PATCH
Edit a porting order
{{baseUrl}}/porting_orders/:id
QUERY PARAMS
id
BODY json
{
"activation_settings": {
"foc_datetime_requested": ""
},
"customer_reference": "",
"end_user": {
"admin": {
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
},
"location": {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
},
"misc": {
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
},
"phone_number_configuration": {
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
},
"requirements": [
{
"field_value": "",
"requirement_type_id": ""
}
],
"user_feedback": {
"user_comment": "",
"user_rating": 0
},
"webhook_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/porting_orders/:id" {:content-type :json
:form-params {:activation_settings {:foc_datetime_requested ""}
:customer_reference ""
:end_user {:admin {:account_number ""
:auth_person_name ""
:billing_phone_number ""
:business_identifier ""
:entity_name ""
:pin_passcode ""
:tax_identifier ""}
:location {:administrative_area ""
:country_code ""
:extended_address ""
:locality ""
:postal_code ""
:street_address ""}}
:misc {:new_billing_phone_number ""
:remaining_numbers_action ""
:type ""}
:phone_number_configuration {:connection_id ""
:emergency_address_id ""
:messaging_profile_id ""
:tags []}
:requirements [{:field_value ""
:requirement_type_id ""}]
:user_feedback {:user_comment ""
:user_rating 0}
:webhook_url ""}})
require "http/client"
url = "{{baseUrl}}/porting_orders/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id"),
Content = new StringContent("{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id"
payload := strings.NewReader("{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/porting_orders/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 961
{
"activation_settings": {
"foc_datetime_requested": ""
},
"customer_reference": "",
"end_user": {
"admin": {
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
},
"location": {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
},
"misc": {
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
},
"phone_number_configuration": {
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
},
"requirements": [
{
"field_value": "",
"requirement_type_id": ""
}
],
"user_feedback": {
"user_comment": "",
"user_rating": 0
},
"webhook_url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/porting_orders/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/porting_orders/:id")
.header("content-type", "application/json")
.body("{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}")
.asString();
const data = JSON.stringify({
activation_settings: {
foc_datetime_requested: ''
},
customer_reference: '',
end_user: {
admin: {
account_number: '',
auth_person_name: '',
billing_phone_number: '',
business_identifier: '',
entity_name: '',
pin_passcode: '',
tax_identifier: ''
},
location: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}
},
misc: {
new_billing_phone_number: '',
remaining_numbers_action: '',
type: ''
},
phone_number_configuration: {
connection_id: '',
emergency_address_id: '',
messaging_profile_id: '',
tags: []
},
requirements: [
{
field_value: '',
requirement_type_id: ''
}
],
user_feedback: {
user_comment: '',
user_rating: 0
},
webhook_url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/porting_orders/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/porting_orders/:id',
headers: {'content-type': 'application/json'},
data: {
activation_settings: {foc_datetime_requested: ''},
customer_reference: '',
end_user: {
admin: {
account_number: '',
auth_person_name: '',
billing_phone_number: '',
business_identifier: '',
entity_name: '',
pin_passcode: '',
tax_identifier: ''
},
location: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}
},
misc: {new_billing_phone_number: '', remaining_numbers_action: '', type: ''},
phone_number_configuration: {
connection_id: '',
emergency_address_id: '',
messaging_profile_id: '',
tags: []
},
requirements: [{field_value: '', requirement_type_id: ''}],
user_feedback: {user_comment: '', user_rating: 0},
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"activation_settings":{"foc_datetime_requested":""},"customer_reference":"","end_user":{"admin":{"account_number":"","auth_person_name":"","billing_phone_number":"","business_identifier":"","entity_name":"","pin_passcode":"","tax_identifier":""},"location":{"administrative_area":"","country_code":"","extended_address":"","locality":"","postal_code":"","street_address":""}},"misc":{"new_billing_phone_number":"","remaining_numbers_action":"","type":""},"phone_number_configuration":{"connection_id":"","emergency_address_id":"","messaging_profile_id":"","tags":[]},"requirements":[{"field_value":"","requirement_type_id":""}],"user_feedback":{"user_comment":"","user_rating":0},"webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "activation_settings": {\n "foc_datetime_requested": ""\n },\n "customer_reference": "",\n "end_user": {\n "admin": {\n "account_number": "",\n "auth_person_name": "",\n "billing_phone_number": "",\n "business_identifier": "",\n "entity_name": "",\n "pin_passcode": "",\n "tax_identifier": ""\n },\n "location": {\n "administrative_area": "",\n "country_code": "",\n "extended_address": "",\n "locality": "",\n "postal_code": "",\n "street_address": ""\n }\n },\n "misc": {\n "new_billing_phone_number": "",\n "remaining_numbers_action": "",\n "type": ""\n },\n "phone_number_configuration": {\n "connection_id": "",\n "emergency_address_id": "",\n "messaging_profile_id": "",\n "tags": []\n },\n "requirements": [\n {\n "field_value": "",\n "requirement_type_id": ""\n }\n ],\n "user_feedback": {\n "user_comment": "",\n "user_rating": 0\n },\n "webhook_url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
activation_settings: {foc_datetime_requested: ''},
customer_reference: '',
end_user: {
admin: {
account_number: '',
auth_person_name: '',
billing_phone_number: '',
business_identifier: '',
entity_name: '',
pin_passcode: '',
tax_identifier: ''
},
location: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}
},
misc: {new_billing_phone_number: '', remaining_numbers_action: '', type: ''},
phone_number_configuration: {
connection_id: '',
emergency_address_id: '',
messaging_profile_id: '',
tags: []
},
requirements: [{field_value: '', requirement_type_id: ''}],
user_feedback: {user_comment: '', user_rating: 0},
webhook_url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/porting_orders/:id',
headers: {'content-type': 'application/json'},
body: {
activation_settings: {foc_datetime_requested: ''},
customer_reference: '',
end_user: {
admin: {
account_number: '',
auth_person_name: '',
billing_phone_number: '',
business_identifier: '',
entity_name: '',
pin_passcode: '',
tax_identifier: ''
},
location: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}
},
misc: {new_billing_phone_number: '', remaining_numbers_action: '', type: ''},
phone_number_configuration: {
connection_id: '',
emergency_address_id: '',
messaging_profile_id: '',
tags: []
},
requirements: [{field_value: '', requirement_type_id: ''}],
user_feedback: {user_comment: '', user_rating: 0},
webhook_url: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/porting_orders/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
activation_settings: {
foc_datetime_requested: ''
},
customer_reference: '',
end_user: {
admin: {
account_number: '',
auth_person_name: '',
billing_phone_number: '',
business_identifier: '',
entity_name: '',
pin_passcode: '',
tax_identifier: ''
},
location: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}
},
misc: {
new_billing_phone_number: '',
remaining_numbers_action: '',
type: ''
},
phone_number_configuration: {
connection_id: '',
emergency_address_id: '',
messaging_profile_id: '',
tags: []
},
requirements: [
{
field_value: '',
requirement_type_id: ''
}
],
user_feedback: {
user_comment: '',
user_rating: 0
},
webhook_url: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/porting_orders/:id',
headers: {'content-type': 'application/json'},
data: {
activation_settings: {foc_datetime_requested: ''},
customer_reference: '',
end_user: {
admin: {
account_number: '',
auth_person_name: '',
billing_phone_number: '',
business_identifier: '',
entity_name: '',
pin_passcode: '',
tax_identifier: ''
},
location: {
administrative_area: '',
country_code: '',
extended_address: '',
locality: '',
postal_code: '',
street_address: ''
}
},
misc: {new_billing_phone_number: '', remaining_numbers_action: '', type: ''},
phone_number_configuration: {
connection_id: '',
emergency_address_id: '',
messaging_profile_id: '',
tags: []
},
requirements: [{field_value: '', requirement_type_id: ''}],
user_feedback: {user_comment: '', user_rating: 0},
webhook_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"activation_settings":{"foc_datetime_requested":""},"customer_reference":"","end_user":{"admin":{"account_number":"","auth_person_name":"","billing_phone_number":"","business_identifier":"","entity_name":"","pin_passcode":"","tax_identifier":""},"location":{"administrative_area":"","country_code":"","extended_address":"","locality":"","postal_code":"","street_address":""}},"misc":{"new_billing_phone_number":"","remaining_numbers_action":"","type":""},"phone_number_configuration":{"connection_id":"","emergency_address_id":"","messaging_profile_id":"","tags":[]},"requirements":[{"field_value":"","requirement_type_id":""}],"user_feedback":{"user_comment":"","user_rating":0},"webhook_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"activation_settings": @{ @"foc_datetime_requested": @"" },
@"customer_reference": @"",
@"end_user": @{ @"admin": @{ @"account_number": @"", @"auth_person_name": @"", @"billing_phone_number": @"", @"business_identifier": @"", @"entity_name": @"", @"pin_passcode": @"", @"tax_identifier": @"" }, @"location": @{ @"administrative_area": @"", @"country_code": @"", @"extended_address": @"", @"locality": @"", @"postal_code": @"", @"street_address": @"" } },
@"misc": @{ @"new_billing_phone_number": @"", @"remaining_numbers_action": @"", @"type": @"" },
@"phone_number_configuration": @{ @"connection_id": @"", @"emergency_address_id": @"", @"messaging_profile_id": @"", @"tags": @[ ] },
@"requirements": @[ @{ @"field_value": @"", @"requirement_type_id": @"" } ],
@"user_feedback": @{ @"user_comment": @"", @"user_rating": @0 },
@"webhook_url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id",
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([
'activation_settings' => [
'foc_datetime_requested' => ''
],
'customer_reference' => '',
'end_user' => [
'admin' => [
'account_number' => '',
'auth_person_name' => '',
'billing_phone_number' => '',
'business_identifier' => '',
'entity_name' => '',
'pin_passcode' => '',
'tax_identifier' => ''
],
'location' => [
'administrative_area' => '',
'country_code' => '',
'extended_address' => '',
'locality' => '',
'postal_code' => '',
'street_address' => ''
]
],
'misc' => [
'new_billing_phone_number' => '',
'remaining_numbers_action' => '',
'type' => ''
],
'phone_number_configuration' => [
'connection_id' => '',
'emergency_address_id' => '',
'messaging_profile_id' => '',
'tags' => [
]
],
'requirements' => [
[
'field_value' => '',
'requirement_type_id' => ''
]
],
'user_feedback' => [
'user_comment' => '',
'user_rating' => 0
],
'webhook_url' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/porting_orders/:id', [
'body' => '{
"activation_settings": {
"foc_datetime_requested": ""
},
"customer_reference": "",
"end_user": {
"admin": {
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
},
"location": {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
},
"misc": {
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
},
"phone_number_configuration": {
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
},
"requirements": [
{
"field_value": "",
"requirement_type_id": ""
}
],
"user_feedback": {
"user_comment": "",
"user_rating": 0
},
"webhook_url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'activation_settings' => [
'foc_datetime_requested' => ''
],
'customer_reference' => '',
'end_user' => [
'admin' => [
'account_number' => '',
'auth_person_name' => '',
'billing_phone_number' => '',
'business_identifier' => '',
'entity_name' => '',
'pin_passcode' => '',
'tax_identifier' => ''
],
'location' => [
'administrative_area' => '',
'country_code' => '',
'extended_address' => '',
'locality' => '',
'postal_code' => '',
'street_address' => ''
]
],
'misc' => [
'new_billing_phone_number' => '',
'remaining_numbers_action' => '',
'type' => ''
],
'phone_number_configuration' => [
'connection_id' => '',
'emergency_address_id' => '',
'messaging_profile_id' => '',
'tags' => [
]
],
'requirements' => [
[
'field_value' => '',
'requirement_type_id' => ''
]
],
'user_feedback' => [
'user_comment' => '',
'user_rating' => 0
],
'webhook_url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'activation_settings' => [
'foc_datetime_requested' => ''
],
'customer_reference' => '',
'end_user' => [
'admin' => [
'account_number' => '',
'auth_person_name' => '',
'billing_phone_number' => '',
'business_identifier' => '',
'entity_name' => '',
'pin_passcode' => '',
'tax_identifier' => ''
],
'location' => [
'administrative_area' => '',
'country_code' => '',
'extended_address' => '',
'locality' => '',
'postal_code' => '',
'street_address' => ''
]
],
'misc' => [
'new_billing_phone_number' => '',
'remaining_numbers_action' => '',
'type' => ''
],
'phone_number_configuration' => [
'connection_id' => '',
'emergency_address_id' => '',
'messaging_profile_id' => '',
'tags' => [
]
],
'requirements' => [
[
'field_value' => '',
'requirement_type_id' => ''
]
],
'user_feedback' => [
'user_comment' => '',
'user_rating' => 0
],
'webhook_url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/porting_orders/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"activation_settings": {
"foc_datetime_requested": ""
},
"customer_reference": "",
"end_user": {
"admin": {
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
},
"location": {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
},
"misc": {
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
},
"phone_number_configuration": {
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
},
"requirements": [
{
"field_value": "",
"requirement_type_id": ""
}
],
"user_feedback": {
"user_comment": "",
"user_rating": 0
},
"webhook_url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"activation_settings": {
"foc_datetime_requested": ""
},
"customer_reference": "",
"end_user": {
"admin": {
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
},
"location": {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
},
"misc": {
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
},
"phone_number_configuration": {
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
},
"requirements": [
{
"field_value": "",
"requirement_type_id": ""
}
],
"user_feedback": {
"user_comment": "",
"user_rating": 0
},
"webhook_url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/porting_orders/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id"
payload = {
"activation_settings": { "foc_datetime_requested": "" },
"customer_reference": "",
"end_user": {
"admin": {
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
},
"location": {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
},
"misc": {
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
},
"phone_number_configuration": {
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
},
"requirements": [
{
"field_value": "",
"requirement_type_id": ""
}
],
"user_feedback": {
"user_comment": "",
"user_rating": 0
},
"webhook_url": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id"
payload <- "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/porting_orders/:id') do |req|
req.body = "{\n \"activation_settings\": {\n \"foc_datetime_requested\": \"\"\n },\n \"customer_reference\": \"\",\n \"end_user\": {\n \"admin\": {\n \"account_number\": \"\",\n \"auth_person_name\": \"\",\n \"billing_phone_number\": \"\",\n \"business_identifier\": \"\",\n \"entity_name\": \"\",\n \"pin_passcode\": \"\",\n \"tax_identifier\": \"\"\n },\n \"location\": {\n \"administrative_area\": \"\",\n \"country_code\": \"\",\n \"extended_address\": \"\",\n \"locality\": \"\",\n \"postal_code\": \"\",\n \"street_address\": \"\"\n }\n },\n \"misc\": {\n \"new_billing_phone_number\": \"\",\n \"remaining_numbers_action\": \"\",\n \"type\": \"\"\n },\n \"phone_number_configuration\": {\n \"connection_id\": \"\",\n \"emergency_address_id\": \"\",\n \"messaging_profile_id\": \"\",\n \"tags\": []\n },\n \"requirements\": [\n {\n \"field_value\": \"\",\n \"requirement_type_id\": \"\"\n }\n ],\n \"user_feedback\": {\n \"user_comment\": \"\",\n \"user_rating\": 0\n },\n \"webhook_url\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id";
let payload = json!({
"activation_settings": json!({"foc_datetime_requested": ""}),
"customer_reference": "",
"end_user": json!({
"admin": json!({
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
}),
"location": json!({
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
})
}),
"misc": json!({
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
}),
"phone_number_configuration": json!({
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": ()
}),
"requirements": (
json!({
"field_value": "",
"requirement_type_id": ""
})
),
"user_feedback": json!({
"user_comment": "",
"user_rating": 0
}),
"webhook_url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/porting_orders/:id \
--header 'content-type: application/json' \
--data '{
"activation_settings": {
"foc_datetime_requested": ""
},
"customer_reference": "",
"end_user": {
"admin": {
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
},
"location": {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
},
"misc": {
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
},
"phone_number_configuration": {
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
},
"requirements": [
{
"field_value": "",
"requirement_type_id": ""
}
],
"user_feedback": {
"user_comment": "",
"user_rating": 0
},
"webhook_url": ""
}'
echo '{
"activation_settings": {
"foc_datetime_requested": ""
},
"customer_reference": "",
"end_user": {
"admin": {
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
},
"location": {
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
}
},
"misc": {
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
},
"phone_number_configuration": {
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
},
"requirements": [
{
"field_value": "",
"requirement_type_id": ""
}
],
"user_feedback": {
"user_comment": "",
"user_rating": 0
},
"webhook_url": ""
}' | \
http PATCH {{baseUrl}}/porting_orders/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "activation_settings": {\n "foc_datetime_requested": ""\n },\n "customer_reference": "",\n "end_user": {\n "admin": {\n "account_number": "",\n "auth_person_name": "",\n "billing_phone_number": "",\n "business_identifier": "",\n "entity_name": "",\n "pin_passcode": "",\n "tax_identifier": ""\n },\n "location": {\n "administrative_area": "",\n "country_code": "",\n "extended_address": "",\n "locality": "",\n "postal_code": "",\n "street_address": ""\n }\n },\n "misc": {\n "new_billing_phone_number": "",\n "remaining_numbers_action": "",\n "type": ""\n },\n "phone_number_configuration": {\n "connection_id": "",\n "emergency_address_id": "",\n "messaging_profile_id": "",\n "tags": []\n },\n "requirements": [\n {\n "field_value": "",\n "requirement_type_id": ""\n }\n ],\n "user_feedback": {\n "user_comment": "",\n "user_rating": 0\n },\n "webhook_url": ""\n}' \
--output-document \
- {{baseUrl}}/porting_orders/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"activation_settings": ["foc_datetime_requested": ""],
"customer_reference": "",
"end_user": [
"admin": [
"account_number": "",
"auth_person_name": "",
"billing_phone_number": "",
"business_identifier": "",
"entity_name": "",
"pin_passcode": "",
"tax_identifier": ""
],
"location": [
"administrative_area": "",
"country_code": "",
"extended_address": "",
"locality": "",
"postal_code": "",
"street_address": ""
]
],
"misc": [
"new_billing_phone_number": "",
"remaining_numbers_action": "",
"type": ""
],
"phone_number_configuration": [
"connection_id": "",
"emergency_address_id": "",
"messaging_profile_id": "",
"tags": []
],
"requirements": [
[
"field_value": "",
"requirement_type_id": ""
]
],
"user_feedback": [
"user_comment": "",
"user_rating": 0
],
"webhook_url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2021-03-19T10:07:15.527Z",
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"old_service_provider_ocn": "Unreal Communications",
"porting_phone_numbers_count": 1,
"record_type": "porting_order",
"support_key": "123abc",
"updated_at": "2021-03-19T10:07:15.527Z",
"user_reference": "Acct 123abc",
"webhook_url": "https://example.com/porting_webhooks"
},
"meta": {
"phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
}
}
GET
List all comments of a porting order
{{baseUrl}}/porting_orders/:id/comments
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id/comments");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/porting_orders/:id/comments")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id/comments"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id/comments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id/comments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id/comments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/porting_orders/:id/comments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/porting_orders/:id/comments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id/comments"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/comments")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/porting_orders/:id/comments")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/porting_orders/:id/comments');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders/:id/comments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id/comments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id/comments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/comments")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id/comments',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders/:id/comments'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/porting_orders/:id/comments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders/:id/comments'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id/comments';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id/comments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id/comments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/porting_orders/:id/comments');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id/comments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id/comments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id/comments' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id/comments' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/porting_orders/:id/comments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id/comments"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id/comments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/porting_orders/:id/comments') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id/comments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/porting_orders/:id/comments
http GET {{baseUrl}}/porting_orders/:id/comments
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/porting_orders/:id/comments
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id/comments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List all exception types
{{baseUrl}}/porting_orders/exception_types
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/exception_types");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/porting_orders/exception_types")
require "http/client"
url = "{{baseUrl}}/porting_orders/exception_types"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/porting_orders/exception_types"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/exception_types");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/exception_types"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/porting_orders/exception_types HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/porting_orders/exception_types")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/exception_types"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/exception_types")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/porting_orders/exception_types")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/porting_orders/exception_types');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/exception_types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/exception_types';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/exception_types',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/exception_types")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/exception_types',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/exception_types'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/porting_orders/exception_types');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/exception_types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/exception_types';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/exception_types"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/exception_types" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/exception_types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/porting_orders/exception_types');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/exception_types');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/exception_types');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/exception_types' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/exception_types' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/porting_orders/exception_types")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/exception_types"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/exception_types"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/exception_types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/porting_orders/exception_types') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/exception_types";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/porting_orders/exception_types
http GET {{baseUrl}}/porting_orders/exception_types
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/porting_orders/exception_types
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/exception_types")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List all porting activation jobs
{{baseUrl}}/porting_orders/:id/activation_jobs
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id/activation_jobs");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/porting_orders/:id/activation_jobs")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id/activation_jobs"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id/activation_jobs"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id/activation_jobs");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id/activation_jobs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/porting_orders/:id/activation_jobs HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/porting_orders/:id/activation_jobs")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id/activation_jobs"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/activation_jobs")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/porting_orders/:id/activation_jobs")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/porting_orders/:id/activation_jobs');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/activation_jobs'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id/activation_jobs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id/activation_jobs',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/activation_jobs")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id/activation_jobs',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/activation_jobs'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/porting_orders/:id/activation_jobs');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/activation_jobs'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id/activation_jobs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id/activation_jobs"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id/activation_jobs" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id/activation_jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/porting_orders/:id/activation_jobs');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id/activation_jobs');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id/activation_jobs');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id/activation_jobs' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id/activation_jobs' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/porting_orders/:id/activation_jobs")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id/activation_jobs"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id/activation_jobs"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id/activation_jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/porting_orders/:id/activation_jobs') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id/activation_jobs";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/porting_orders/:id/activation_jobs
http GET {{baseUrl}}/porting_orders/:id/activation_jobs
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/porting_orders/:id/activation_jobs
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id/activation_jobs")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List all porting orders
{{baseUrl}}/porting_orders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/porting_orders")
require "http/client"
url = "{{baseUrl}}/porting_orders"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/porting_orders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/porting_orders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/porting_orders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/porting_orders")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/porting_orders');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/porting_orders');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/porting_orders');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/porting_orders")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/porting_orders') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/porting_orders
http GET {{baseUrl}}/porting_orders
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/porting_orders
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List all porting phone numbers
{{baseUrl}}/porting_phone_numbers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_phone_numbers");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/porting_phone_numbers")
require "http/client"
url = "{{baseUrl}}/porting_phone_numbers"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/porting_phone_numbers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_phone_numbers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_phone_numbers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/porting_phone_numbers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/porting_phone_numbers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_phone_numbers"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_phone_numbers")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/porting_phone_numbers")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/porting_phone_numbers');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/porting_phone_numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_phone_numbers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_phone_numbers")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_phone_numbers',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/porting_phone_numbers'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/porting_phone_numbers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/porting_phone_numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_phone_numbers';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_phone_numbers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_phone_numbers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_phone_numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/porting_phone_numbers');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_phone_numbers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_phone_numbers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_phone_numbers' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_phone_numbers' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/porting_phone_numbers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_phone_numbers"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_phone_numbers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_phone_numbers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/porting_phone_numbers') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_phone_numbers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/porting_phone_numbers
http GET {{baseUrl}}/porting_phone_numbers
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/porting_phone_numbers
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_phone_numbers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"phone_number": "+19705555098",
"record_type": "number_order_phone_number",
"regulatory_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"regulatory_requirements": [
{
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
}
],
"requirements_met": true,
"status": "success"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
DELETE
Request cancellation
{{baseUrl}}/porting_orders/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/porting_orders/:id")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/porting_orders/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/porting_orders/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/porting_orders/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/porting_orders/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/porting_orders/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/porting_orders/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/porting_orders/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/porting_orders/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/porting_orders/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/porting_orders/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/porting_orders/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/porting_orders/:id
http DELETE {{baseUrl}}/porting_orders/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/porting_orders/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2021-03-19T10:07:15.527Z",
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"old_service_provider_ocn": "Unreal Communications",
"porting_phone_numbers_count": 1,
"record_type": "porting_order",
"support_key": "123abc",
"updated_at": "2021-03-19T10:07:15.527Z",
"user_reference": "Acct 123abc",
"webhook_url": "https://example.com/porting_webhooks"
},
"meta": {
"phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
}
}
GET
Retrieve a porting activation job
{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId
QUERY PARAMS
id
activationJobId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/porting_orders/:id/activation_jobs/:activationJobId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id/activation_jobs/:activationJobId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/porting_orders/:id/activation_jobs/:activationJobId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/porting_orders/:id/activation_jobs/:activationJobId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId
http GET {{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id/activation_jobs/:activationJobId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2021-03-19T10:07:15.527Z",
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"record_type": "porting_activation_job",
"updated_at": "2021-03-19T10:07:15.527Z"
}
}
GET
Retrieve a porting order
{{baseUrl}}/porting_orders/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/porting_orders/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/porting_orders/:id")
require "http/client"
url = "{{baseUrl}}/porting_orders/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/porting_orders/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/porting_orders/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/porting_orders/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/porting_orders/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/porting_orders/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/porting_orders/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/porting_orders/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/porting_orders/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/porting_orders/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/porting_orders/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/porting_orders/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/porting_orders/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/porting_orders/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/porting_orders/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/porting_orders/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/porting_orders/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/porting_orders/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/porting_orders/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/porting_orders/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/porting_orders/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/porting_orders/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/porting_orders/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/porting_orders/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/porting_orders/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/porting_orders/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/porting_orders/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/porting_orders/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/porting_orders/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/porting_orders/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/porting_orders/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/porting_orders/:id
http GET {{baseUrl}}/porting_orders/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/porting_orders/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/porting_orders/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2021-03-19T10:07:15.527Z",
"id": "f1486bae-f067-460c-ad43-73a92848f902",
"old_service_provider_ocn": "Unreal Communications",
"porting_phone_numbers_count": 1,
"record_type": "porting_order",
"support_key": "123abc",
"updated_at": "2021-03-19T10:07:15.527Z",
"user_reference": "Acct 123abc",
"webhook_url": "https://example.com/porting_webhooks"
},
"meta": {
"phone_numbers_url": "/porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2"
}
}
POST
Create a Private Wireless Gateway
{{baseUrl}}/private_wireless_gateways
BODY json
{
"name": "",
"network_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/private_wireless_gateways");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"name\": \"\",\n \"network_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/private_wireless_gateways" {:content-type :json
:form-params {:name ""
:network_id ""}})
require "http/client"
url = "{{baseUrl}}/private_wireless_gateways"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"name\": \"\",\n \"network_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/private_wireless_gateways"),
Content = new StringContent("{\n \"name\": \"\",\n \"network_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/private_wireless_gateways");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"name\": \"\",\n \"network_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/private_wireless_gateways"
payload := strings.NewReader("{\n \"name\": \"\",\n \"network_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/private_wireless_gateways HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 36
{
"name": "",
"network_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/private_wireless_gateways")
.setHeader("content-type", "application/json")
.setBody("{\n \"name\": \"\",\n \"network_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/private_wireless_gateways"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"name\": \"\",\n \"network_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"network_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/private_wireless_gateways")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/private_wireless_gateways")
.header("content-type", "application/json")
.body("{\n \"name\": \"\",\n \"network_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
name: '',
network_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/private_wireless_gateways');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/private_wireless_gateways',
headers: {'content-type': 'application/json'},
data: {name: '', network_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/private_wireless_gateways';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","network_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/private_wireless_gateways',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "name": "",\n "network_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"name\": \"\",\n \"network_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/private_wireless_gateways")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/private_wireless_gateways',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({name: '', network_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/private_wireless_gateways',
headers: {'content-type': 'application/json'},
body: {name: '', network_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/private_wireless_gateways');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
name: '',
network_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/private_wireless_gateways',
headers: {'content-type': 'application/json'},
data: {name: '', network_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/private_wireless_gateways';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"name":"","network_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"name": @"",
@"network_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/private_wireless_gateways"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/private_wireless_gateways" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"name\": \"\",\n \"network_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/private_wireless_gateways",
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' => '',
'network_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/private_wireless_gateways', [
'body' => '{
"name": "",
"network_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/private_wireless_gateways');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'name' => '',
'network_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'name' => '',
'network_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/private_wireless_gateways');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/private_wireless_gateways' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"network_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/private_wireless_gateways' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"name": "",
"network_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"name\": \"\",\n \"network_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/private_wireless_gateways", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/private_wireless_gateways"
payload = {
"name": "",
"network_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/private_wireless_gateways"
payload <- "{\n \"name\": \"\",\n \"network_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/private_wireless_gateways")
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 \"name\": \"\",\n \"network_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/private_wireless_gateways') do |req|
req.body = "{\n \"name\": \"\",\n \"network_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/private_wireless_gateways";
let payload = json!({
"name": "",
"network_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/private_wireless_gateways \
--header 'content-type: application/json' \
--data '{
"name": "",
"network_id": ""
}'
echo '{
"name": "",
"network_id": ""
}' | \
http POST {{baseUrl}}/private_wireless_gateways \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "name": "",\n "network_id": ""\n}' \
--output-document \
- {{baseUrl}}/private_wireless_gateways
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"name": "",
"network_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/private_wireless_gateways")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"ip_range": "100.64.1.0/24",
"name": "My private wireless gateway",
"network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "private_wireless_gateway",
"region_code": "ashburn-va",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
DELETE
Delete a Private Wireless Gateway
{{baseUrl}}/private_wireless_gateways/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/private_wireless_gateways/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/private_wireless_gateways/:id")
require "http/client"
url = "{{baseUrl}}/private_wireless_gateways/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/private_wireless_gateways/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/private_wireless_gateways/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/private_wireless_gateways/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/private_wireless_gateways/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/private_wireless_gateways/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/private_wireless_gateways/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/private_wireless_gateways/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/private_wireless_gateways/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/private_wireless_gateways/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/private_wireless_gateways/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/private_wireless_gateways/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/private_wireless_gateways/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/private_wireless_gateways/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/private_wireless_gateways/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/private_wireless_gateways/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/private_wireless_gateways/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/private_wireless_gateways/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/private_wireless_gateways/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/private_wireless_gateways/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/private_wireless_gateways/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/private_wireless_gateways/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/private_wireless_gateways/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/private_wireless_gateways/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/private_wireless_gateways/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/private_wireless_gateways/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/private_wireless_gateways/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/private_wireless_gateways/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/private_wireless_gateways/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/private_wireless_gateways/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/private_wireless_gateways/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/private_wireless_gateways/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/private_wireless_gateways/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/private_wireless_gateways/:id
http DELETE {{baseUrl}}/private_wireless_gateways/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/private_wireless_gateways/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/private_wireless_gateways/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"ip_range": "100.64.1.0/24",
"name": "My private wireless gateway",
"network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "private_wireless_gateway",
"region_code": "ashburn-va",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get a Private Wireless Gateway
{{baseUrl}}/private_wireless_gateways/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/private_wireless_gateways/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/private_wireless_gateways/:id")
require "http/client"
url = "{{baseUrl}}/private_wireless_gateways/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/private_wireless_gateways/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/private_wireless_gateways/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/private_wireless_gateways/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/private_wireless_gateways/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/private_wireless_gateways/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/private_wireless_gateways/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/private_wireless_gateways/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/private_wireless_gateways/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/private_wireless_gateways/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/private_wireless_gateways/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/private_wireless_gateways/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/private_wireless_gateways/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/private_wireless_gateways/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/private_wireless_gateways/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/private_wireless_gateways/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/private_wireless_gateways/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/private_wireless_gateways/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/private_wireless_gateways/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/private_wireless_gateways/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/private_wireless_gateways/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/private_wireless_gateways/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/private_wireless_gateways/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/private_wireless_gateways/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/private_wireless_gateways/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/private_wireless_gateways/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/private_wireless_gateways/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/private_wireless_gateways/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/private_wireless_gateways/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/private_wireless_gateways/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/private_wireless_gateways/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/private_wireless_gateways/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/private_wireless_gateways/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/private_wireless_gateways/:id
http GET {{baseUrl}}/private_wireless_gateways/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/private_wireless_gateways/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/private_wireless_gateways/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"ip_range": "100.64.1.0/24",
"name": "My private wireless gateway",
"network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "private_wireless_gateway",
"region_code": "ashburn-va",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get all Private Wireless Gateways
{{baseUrl}}/private_wireless_gateways
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/private_wireless_gateways");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/private_wireless_gateways")
require "http/client"
url = "{{baseUrl}}/private_wireless_gateways"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/private_wireless_gateways"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/private_wireless_gateways");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/private_wireless_gateways"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/private_wireless_gateways HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/private_wireless_gateways")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/private_wireless_gateways"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/private_wireless_gateways")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/private_wireless_gateways")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/private_wireless_gateways');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/private_wireless_gateways'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/private_wireless_gateways';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/private_wireless_gateways',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/private_wireless_gateways")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/private_wireless_gateways',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/private_wireless_gateways'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/private_wireless_gateways');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/private_wireless_gateways'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/private_wireless_gateways';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/private_wireless_gateways"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/private_wireless_gateways" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/private_wireless_gateways",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/private_wireless_gateways');
echo $response->getBody();
setUrl('{{baseUrl}}/private_wireless_gateways');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/private_wireless_gateways');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/private_wireless_gateways' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/private_wireless_gateways' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/private_wireless_gateways")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/private_wireless_gateways"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/private_wireless_gateways"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/private_wireless_gateways")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/private_wireless_gateways') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/private_wireless_gateways";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/private_wireless_gateways
http GET {{baseUrl}}/private_wireless_gateways
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/private_wireless_gateways
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/private_wireless_gateways")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Creates a Fax Application
{{baseUrl}}/fax_applications
BODY json
{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fax_applications");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/fax_applications" {:content-type :json
:form-params {:active false
:anchorsite_override ""
:application_name ""
:inbound {:channel_limit 0
:sip_subdomain ""
:sip_subdomain_receive_settings ""}
:outbound {:channel_limit 0
:outbound_voice_profile_id ""}
:webhook_event_failover_url ""
:webhook_event_url ""
:webhook_timeout_secs 0}})
require "http/client"
url = "{{baseUrl}}/fax_applications"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/fax_applications"),
Content = new StringContent("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fax_applications");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fax_applications"
payload := strings.NewReader("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/fax_applications HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 359
{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/fax_applications")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fax_applications"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/fax_applications")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/fax_applications")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.asString();
const data = JSON.stringify({
active: false,
anchorsite_override: '',
application_name: '',
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/fax_applications');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/fax_applications',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
application_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fax_applications';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","application_name":"","inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fax_applications',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "anchorsite_override": "",\n "application_name": "",\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/fax_applications")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/fax_applications',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
anchorsite_override: '',
application_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/fax_applications',
headers: {'content-type': 'application/json'},
body: {
active: false,
anchorsite_override: '',
application_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/fax_applications');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
anchorsite_override: '',
application_name: '',
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/fax_applications',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
application_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fax_applications';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","application_name":"","inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"anchorsite_override": @"",
@"application_name": @"",
@"inbound": @{ @"channel_limit": @0, @"sip_subdomain": @"", @"sip_subdomain_receive_settings": @"" },
@"outbound": @{ @"channel_limit": @0, @"outbound_voice_profile_id": @"" },
@"webhook_event_failover_url": @"",
@"webhook_event_url": @"",
@"webhook_timeout_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fax_applications"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fax_applications" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fax_applications",
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([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]),
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;
}
request('POST', '{{baseUrl}}/fax_applications', [
'body' => '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/fax_applications');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/fax_applications');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fax_applications' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fax_applications' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/fax_applications", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fax_applications"
payload = {
"active": False,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fax_applications"
payload <- "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fax_applications")
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 \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/fax_applications') do |req|
req.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fax_applications";
let payload = json!({
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": json!({
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
}),
"outbound": json!({
"channel_limit": 0,
"outbound_voice_profile_id": ""
}),
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/fax_applications \
--header 'content-type: application/json' \
--data '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
echo '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}' | \
http POST {{baseUrl}}/fax_applications \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "anchorsite_override": "",\n "application_name": "",\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}' \
--output-document \
- {{baseUrl}}/fax_applications
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": [
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
],
"outbound": [
"channel_limit": 0,
"outbound_voice_profile_id": ""
],
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fax_applications")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"application_name": "fax-router",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "fax_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
DELETE
Deletes a Fax Application
{{baseUrl}}/fax_applications/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fax_applications/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/fax_applications/:id")
require "http/client"
url = "{{baseUrl}}/fax_applications/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/fax_applications/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fax_applications/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fax_applications/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/fax_applications/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/fax_applications/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fax_applications/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fax_applications/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/fax_applications/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/fax_applications/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/fax_applications/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fax_applications/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fax_applications/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fax_applications/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/fax_applications/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/fax_applications/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/fax_applications/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/fax_applications/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fax_applications/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fax_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fax_applications/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fax_applications/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/fax_applications/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/fax_applications/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fax_applications/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fax_applications/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fax_applications/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/fax_applications/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fax_applications/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fax_applications/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fax_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/fax_applications/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fax_applications/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/fax_applications/:id
http DELETE {{baseUrl}}/fax_applications/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/fax_applications/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fax_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"application_name": "fax-router",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "fax_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
GET
List all Fax Applications
{{baseUrl}}/fax_applications
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fax_applications");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/fax_applications")
require "http/client"
url = "{{baseUrl}}/fax_applications"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/fax_applications"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fax_applications");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fax_applications"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/fax_applications HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/fax_applications")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fax_applications"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fax_applications")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/fax_applications")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/fax_applications');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/fax_applications'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fax_applications';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fax_applications',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fax_applications")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/fax_applications',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/fax_applications'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/fax_applications');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/fax_applications'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fax_applications';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fax_applications"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fax_applications" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fax_applications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/fax_applications');
echo $response->getBody();
setUrl('{{baseUrl}}/fax_applications');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fax_applications');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fax_applications' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fax_applications' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/fax_applications")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fax_applications"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fax_applications"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fax_applications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/fax_applications') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fax_applications";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/fax_applications
http GET {{baseUrl}}/fax_applications
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/fax_applications
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fax_applications")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"application_name": "fax-router",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "fax_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a Fax Application
{{baseUrl}}/fax_applications/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fax_applications/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/fax_applications/:id")
require "http/client"
url = "{{baseUrl}}/fax_applications/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/fax_applications/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fax_applications/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fax_applications/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/fax_applications/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/fax_applications/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fax_applications/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/fax_applications/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/fax_applications/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/fax_applications/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/fax_applications/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fax_applications/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fax_applications/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/fax_applications/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/fax_applications/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/fax_applications/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/fax_applications/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/fax_applications/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fax_applications/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fax_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fax_applications/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fax_applications/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/fax_applications/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/fax_applications/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/fax_applications/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fax_applications/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fax_applications/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/fax_applications/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fax_applications/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fax_applications/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fax_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/fax_applications/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fax_applications/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/fax_applications/:id
http GET {{baseUrl}}/fax_applications/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/fax_applications/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fax_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"application_name": "fax-router",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "fax_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
PATCH
Update a Fax Application
{{baseUrl}}/fax_applications/:id
QUERY PARAMS
id
BODY json
{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/fax_applications/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/fax_applications/:id" {:content-type :json
:form-params {:active false
:anchorsite_override ""
:application_name ""
:inbound {:channel_limit 0
:sip_subdomain ""
:sip_subdomain_receive_settings ""}
:outbound {:channel_limit 0
:outbound_voice_profile_id ""}
:webhook_event_failover_url ""
:webhook_event_url ""
:webhook_timeout_secs 0}})
require "http/client"
url = "{{baseUrl}}/fax_applications/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/fax_applications/:id"),
Content = new StringContent("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/fax_applications/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/fax_applications/:id"
payload := strings.NewReader("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/fax_applications/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 359
{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/fax_applications/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/fax_applications/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/fax_applications/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/fax_applications/:id")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
.asString();
const data = JSON.stringify({
active: false,
anchorsite_override: '',
application_name: '',
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/fax_applications/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/fax_applications/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
application_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/fax_applications/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","application_name":"","inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/fax_applications/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "anchorsite_override": "",\n "application_name": "",\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/fax_applications/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/fax_applications/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
anchorsite_override: '',
application_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/fax_applications/:id',
headers: {'content-type': 'application/json'},
body: {
active: false,
anchorsite_override: '',
application_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/fax_applications/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
anchorsite_override: '',
application_name: '',
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/fax_applications/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
application_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
webhook_event_failover_url: '',
webhook_event_url: '',
webhook_timeout_secs: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/fax_applications/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","application_name":"","inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"webhook_event_failover_url":"","webhook_event_url":"","webhook_timeout_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"anchorsite_override": @"",
@"application_name": @"",
@"inbound": @{ @"channel_limit": @0, @"sip_subdomain": @"", @"sip_subdomain_receive_settings": @"" },
@"outbound": @{ @"channel_limit": @0, @"outbound_voice_profile_id": @"" },
@"webhook_event_failover_url": @"",
@"webhook_event_url": @"",
@"webhook_timeout_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/fax_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/fax_applications/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/fax_applications/:id",
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([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]),
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;
}
request('PATCH', '{{baseUrl}}/fax_applications/:id', [
'body' => '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/fax_applications/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'anchorsite_override' => '',
'application_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'webhook_event_failover_url' => '',
'webhook_event_url' => '',
'webhook_timeout_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/fax_applications/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/fax_applications/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/fax_applications/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/fax_applications/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/fax_applications/:id"
payload = {
"active": False,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/fax_applications/:id"
payload <- "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/fax_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/fax_applications/:id') do |req|
req.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"application_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"webhook_event_failover_url\": \"\",\n \"webhook_event_url\": \"\",\n \"webhook_timeout_secs\": 0\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/fax_applications/:id";
let payload = json!({
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": json!({
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
}),
"outbound": json!({
"channel_limit": 0,
"outbound_voice_profile_id": ""
}),
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/fax_applications/:id \
--header 'content-type: application/json' \
--data '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}'
echo '{
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
}' | \
http PATCH {{baseUrl}}/fax_applications/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "anchorsite_override": "",\n "application_name": "",\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "webhook_event_failover_url": "",\n "webhook_event_url": "",\n "webhook_timeout_secs": 0\n}' \
--output-document \
- {{baseUrl}}/fax_applications/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"anchorsite_override": "",
"application_name": "",
"inbound": [
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
],
"outbound": [
"channel_limit": 0,
"outbound_voice_profile_id": ""
],
"webhook_event_failover_url": "",
"webhook_event_url": "",
"webhook_timeout_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/fax_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"application_name": "fax-router",
"created_at": "2018-02-02T22:25:27.521Z",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "fax_application",
"updated_at": "2018-02-02T22:25:27.521Z",
"webhook_event_failover_url": "https://failover.example.com",
"webhook_event_url": "https://example.com",
"webhook_timeout_secs": 25
}
}
DELETE
Delete a fax
{{baseUrl}}/faxes/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/faxes/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/faxes/:id")
require "http/client"
url = "{{baseUrl}}/faxes/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/faxes/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/faxes/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/faxes/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/faxes/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/faxes/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/faxes/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/faxes/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/faxes/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/faxes/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/faxes/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/faxes/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/faxes/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/faxes/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/faxes/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/faxes/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/faxes/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/faxes/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/faxes/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/faxes/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/faxes/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/faxes/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/faxes/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/faxes/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/faxes/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/faxes/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/faxes/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/faxes/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/faxes/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/faxes/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/faxes/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/faxes/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/faxes/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/faxes/:id
http DELETE {{baseUrl}}/faxes/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/faxes/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/faxes/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Refresh a fax
{{baseUrl}}/faxes/:id/actions/refresh
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/faxes/:id/actions/refresh");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/faxes/:id/actions/refresh")
require "http/client"
url = "{{baseUrl}}/faxes/:id/actions/refresh"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/faxes/:id/actions/refresh"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/faxes/:id/actions/refresh");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/faxes/:id/actions/refresh"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/faxes/:id/actions/refresh HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/faxes/:id/actions/refresh")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/faxes/:id/actions/refresh"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/faxes/:id/actions/refresh")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/faxes/:id/actions/refresh")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/faxes/:id/actions/refresh');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/faxes/:id/actions/refresh'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/faxes/:id/actions/refresh';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/faxes/:id/actions/refresh',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/faxes/:id/actions/refresh")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/faxes/:id/actions/refresh',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'POST', url: '{{baseUrl}}/faxes/:id/actions/refresh'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/faxes/:id/actions/refresh');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'POST', url: '{{baseUrl}}/faxes/:id/actions/refresh'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/faxes/:id/actions/refresh';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/faxes/:id/actions/refresh"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/faxes/:id/actions/refresh" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/faxes/:id/actions/refresh",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/faxes/:id/actions/refresh');
echo $response->getBody();
setUrl('{{baseUrl}}/faxes/:id/actions/refresh');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/faxes/:id/actions/refresh');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/faxes/:id/actions/refresh' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/faxes/:id/actions/refresh' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/faxes/:id/actions/refresh")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/faxes/:id/actions/refresh"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/faxes/:id/actions/refresh"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/faxes/:id/actions/refresh")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/faxes/:id/actions/refresh') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/faxes/:id/actions/refresh";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/faxes/:id/actions/refresh
http POST {{baseUrl}}/faxes/:id/actions/refresh
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/faxes/:id/actions/refresh
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/faxes/:id/actions/refresh")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"result": "ok"
}
}
POST
Send a fax
{{baseUrl}}/faxes
BODY json
{
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/faxes");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/faxes" {:content-type :json
:form-params {:connection_id ""
:from ""
:media_name ""
:media_url ""
:quality ""
:store_media false
:to ""}})
require "http/client"
url = "{{baseUrl}}/faxes"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/faxes"),
Content = new StringContent("{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/faxes");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/faxes"
payload := strings.NewReader("{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/faxes HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 131
{
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/faxes")
.setHeader("content-type", "application/json")
.setBody("{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/faxes"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/faxes")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/faxes")
.header("content-type", "application/json")
.body("{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}")
.asString();
const data = JSON.stringify({
connection_id: '',
from: '',
media_name: '',
media_url: '',
quality: '',
store_media: false,
to: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/faxes');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/faxes',
headers: {'content-type': 'application/json'},
data: {
connection_id: '',
from: '',
media_name: '',
media_url: '',
quality: '',
store_media: false,
to: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/faxes';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","from":"","media_name":"","media_url":"","quality":"","store_media":false,"to":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/faxes',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "connection_id": "",\n "from": "",\n "media_name": "",\n "media_url": "",\n "quality": "",\n "store_media": false,\n "to": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/faxes")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/faxes',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
connection_id: '',
from: '',
media_name: '',
media_url: '',
quality: '',
store_media: false,
to: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/faxes',
headers: {'content-type': 'application/json'},
body: {
connection_id: '',
from: '',
media_name: '',
media_url: '',
quality: '',
store_media: false,
to: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/faxes');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
connection_id: '',
from: '',
media_name: '',
media_url: '',
quality: '',
store_media: false,
to: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/faxes',
headers: {'content-type': 'application/json'},
data: {
connection_id: '',
from: '',
media_name: '',
media_url: '',
quality: '',
store_media: false,
to: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/faxes';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"connection_id":"","from":"","media_name":"","media_url":"","quality":"","store_media":false,"to":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"connection_id": @"",
@"from": @"",
@"media_name": @"",
@"media_url": @"",
@"quality": @"",
@"store_media": @NO,
@"to": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/faxes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/faxes" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/faxes",
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([
'connection_id' => '',
'from' => '',
'media_name' => '',
'media_url' => '',
'quality' => '',
'store_media' => null,
'to' => ''
]),
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;
}
request('POST', '{{baseUrl}}/faxes', [
'body' => '{
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/faxes');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'connection_id' => '',
'from' => '',
'media_name' => '',
'media_url' => '',
'quality' => '',
'store_media' => null,
'to' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'connection_id' => '',
'from' => '',
'media_name' => '',
'media_url' => '',
'quality' => '',
'store_media' => null,
'to' => ''
]));
$request->setRequestUrl('{{baseUrl}}/faxes');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/faxes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/faxes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/faxes", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/faxes"
payload = {
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": False,
"to": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/faxes"
payload <- "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/faxes")
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 \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/faxes') do |req|
req.body = "{\n \"connection_id\": \"\",\n \"from\": \"\",\n \"media_name\": \"\",\n \"media_url\": \"\",\n \"quality\": \"\",\n \"store_media\": false,\n \"to\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/faxes";
let payload = json!({
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/faxes \
--header 'content-type: application/json' \
--data '{
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
}'
echo '{
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
}' | \
http POST {{baseUrl}}/faxes \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "connection_id": "",\n "from": "",\n "media_name": "",\n "media_url": "",\n "quality": "",\n "store_media": false,\n "to": ""\n}' \
--output-document \
- {{baseUrl}}/faxes
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"connection_id": "",
"from": "",
"media_name": "",
"media_url": "",
"quality": "",
"store_media": false,
"to": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/faxes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "c-1",
"created_at": "2020-05-05T09:59:12",
"direction": "outbound",
"from": "+123",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"media_url": "http://www.example.com/fax.pdf",
"quality": "high",
"record_type": "fax",
"status": "queued",
"store_media": true,
"stored_media_url": "https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51",
"to": "+456",
"updated_at": "2020-05-05T09:59:12",
"webhook_failover_url": "",
"webhook_url": "http://www.example.com/webhooks"
}
}
GET
View a fax
{{baseUrl}}/faxes/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/faxes/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/faxes/:id")
require "http/client"
url = "{{baseUrl}}/faxes/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/faxes/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/faxes/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/faxes/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/faxes/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/faxes/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/faxes/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/faxes/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/faxes/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/faxes/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/faxes/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/faxes/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/faxes/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/faxes/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/faxes/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/faxes/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/faxes/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/faxes/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/faxes/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/faxes/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/faxes/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/faxes/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/faxes/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/faxes/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/faxes/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/faxes/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/faxes/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/faxes/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/faxes/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/faxes/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/faxes/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/faxes/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/faxes/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/faxes/:id
http GET {{baseUrl}}/faxes/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/faxes/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/faxes/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"connection_id": "c-1",
"created_at": "2020-05-05T09:59:12",
"direction": "outbound",
"from": "+123",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"media_url": "http://www.example.com/fax.pdf",
"quality": "high",
"record_type": "fax",
"status": "queued",
"store_media": true,
"stored_media_url": "https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51",
"to": "+456",
"updated_at": "2020-05-05T09:59:12",
"webhook_failover_url": "",
"webhook_url": "http://www.example.com/webhooks"
}
}
GET
View a list of faxes
{{baseUrl}}/faxes
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/faxes");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/faxes")
require "http/client"
url = "{{baseUrl}}/faxes"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/faxes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/faxes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/faxes"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/faxes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/faxes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/faxes"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/faxes")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/faxes")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/faxes');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/faxes'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/faxes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/faxes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/faxes")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/faxes',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/faxes'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/faxes');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/faxes'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/faxes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/faxes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/faxes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/faxes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/faxes');
echo $response->getBody();
setUrl('{{baseUrl}}/faxes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/faxes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/faxes' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/faxes' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/faxes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/faxes"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/faxes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/faxes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/faxes') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/faxes";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/faxes
http GET {{baseUrl}}/faxes
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/faxes
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/faxes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"connection_id": "c-1",
"created_at": "2020-05-05T09:59:12",
"direction": "outbound",
"from": "+123",
"id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
"media_url": "http://www.example.com/fax.pdf",
"quality": "high",
"record_type": "fax",
"status": "queued",
"store_media": true,
"stored_media_url": "https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51",
"to": "+456",
"updated_at": "2020-05-05T09:59:12",
"webhook_failover_url": "",
"webhook_url": "http://www.example.com/webhooks"
}
],
"meta": {
"page_number": 2,
"page_size": 1,
"total_pages": 3,
"total_results": 3
}
}
GET
Retrieve a call from a queue
{{baseUrl}}/queues/:queue_name/calls/:call_control_id
QUERY PARAMS
queue_name
call_control_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/queues/:queue_name/calls/:call_control_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/queues/:queue_name/calls/:call_control_id")
require "http/client"
url = "{{baseUrl}}/queues/:queue_name/calls/:call_control_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/queues/:queue_name/calls/:call_control_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/queues/:queue_name/calls/:call_control_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/queues/:queue_name/calls/:call_control_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/queues/:queue_name/calls/:call_control_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/queues/:queue_name/calls/:call_control_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/queues/:queue_name/calls/:call_control_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/queues/:queue_name/calls/:call_control_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/queues/:queue_name/calls/:call_control_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/queues/:queue_name/calls/:call_control_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/queues/:queue_name/calls/:call_control_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/queues/:queue_name/calls/:call_control_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/queues/:queue_name/calls/:call_control_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/queues/:queue_name/calls/:call_control_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/queues/:queue_name/calls/:call_control_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/queues/:queue_name/calls/:call_control_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/queues/:queue_name/calls/:call_control_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/queues/:queue_name/calls/:call_control_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/queues/:queue_name/calls/:call_control_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/queues/:queue_name/calls/:call_control_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/queues/:queue_name/calls/:call_control_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/queues/:queue_name/calls/:call_control_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/queues/:queue_name/calls/:call_control_id');
echo $response->getBody();
setUrl('{{baseUrl}}/queues/:queue_name/calls/:call_control_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/queues/:queue_name/calls/:call_control_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/queues/:queue_name/calls/:call_control_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/queues/:queue_name/calls/:call_control_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/queues/:queue_name/calls/:call_control_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/queues/:queue_name/calls/:call_control_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/queues/:queue_name/calls/:call_control_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/queues/:queue_name/calls/:call_control_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/queues/:queue_name/calls/:call_control_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/queues/:queue_name/calls/:call_control_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/queues/:queue_name/calls/:call_control_id
http GET {{baseUrl}}/queues/:queue_name/calls/:call_control_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/queues/:queue_name/calls/:call_control_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/queues/:queue_name/calls/:call_control_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ",
"call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
"call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
"connection_id": "7267xxxxxxxxxxxxxx",
"enqueued_at": "2019-01-23T18:10:02.574Z",
"from": "+18005550101",
"queue_id": "ae1626cc-6f42-11ea-becd-02420a0f8b69",
"queue_position": 3,
"record_type": "queue_call",
"to": "+18005550102",
"wait_time_secs": 145
}
}
GET
Retrieve a call queue
{{baseUrl}}/queues/:queue_name
QUERY PARAMS
queue_name
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/queues/:queue_name");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/queues/:queue_name")
require "http/client"
url = "{{baseUrl}}/queues/:queue_name"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/queues/:queue_name"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/queues/:queue_name");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/queues/:queue_name"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/queues/:queue_name HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/queues/:queue_name")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/queues/:queue_name"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/queues/:queue_name")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/queues/:queue_name")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/queues/:queue_name');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/queues/:queue_name'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/queues/:queue_name';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/queues/:queue_name',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/queues/:queue_name")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/queues/:queue_name',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/queues/:queue_name'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/queues/:queue_name');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/queues/:queue_name'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/queues/:queue_name';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/queues/:queue_name"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/queues/:queue_name" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/queues/:queue_name",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/queues/:queue_name');
echo $response->getBody();
setUrl('{{baseUrl}}/queues/:queue_name');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/queues/:queue_name');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/queues/:queue_name' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/queues/:queue_name' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/queues/:queue_name")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/queues/:queue_name"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/queues/:queue_name"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/queues/:queue_name")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/queues/:queue_name') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/queues/:queue_name";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/queues/:queue_name
http GET {{baseUrl}}/queues/:queue_name
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/queues/:queue_name
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/queues/:queue_name")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"average_wait_time_secs": 175,
"created_at": "2019-01-23T18:10:02.574Z",
"current_size": 20,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"max_size": 50,
"name": "support",
"record_type": "queue",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
GET
Retrieve calls from a queue
{{baseUrl}}/queues/:queue_name/calls
QUERY PARAMS
queue_name
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/queues/:queue_name/calls");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/queues/:queue_name/calls")
require "http/client"
url = "{{baseUrl}}/queues/:queue_name/calls"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/queues/:queue_name/calls"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/queues/:queue_name/calls");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/queues/:queue_name/calls"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/queues/:queue_name/calls HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/queues/:queue_name/calls")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/queues/:queue_name/calls"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/queues/:queue_name/calls")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/queues/:queue_name/calls")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/queues/:queue_name/calls');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/queues/:queue_name/calls'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/queues/:queue_name/calls';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/queues/:queue_name/calls',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/queues/:queue_name/calls")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/queues/:queue_name/calls',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/queues/:queue_name/calls'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/queues/:queue_name/calls');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/queues/:queue_name/calls'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/queues/:queue_name/calls';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/queues/:queue_name/calls"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/queues/:queue_name/calls" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/queues/:queue_name/calls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/queues/:queue_name/calls');
echo $response->getBody();
setUrl('{{baseUrl}}/queues/:queue_name/calls');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/queues/:queue_name/calls');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/queues/:queue_name/calls' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/queues/:queue_name/calls' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/queues/:queue_name/calls")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/queues/:queue_name/calls"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/queues/:queue_name/calls"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/queues/:queue_name/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/queues/:queue_name/calls') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/queues/:queue_name/calls";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/queues/:queue_name/calls
http GET {{baseUrl}}/queues/:queue_name/calls
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/queues/:queue_name/calls
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/queues/:queue_name/calls")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ",
"call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
"call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
"connection_id": "7267xxxxxxxxxxxxxx",
"enqueued_at": "2019-01-23T18:10:02.574Z",
"from": "+18005550101",
"queue_id": "ae1626cc-6f42-11ea-becd-02420a0f8b69",
"queue_position": 3,
"record_type": "queue_call",
"to": "+18005550102",
"wait_time_secs": 145
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List recordings
{{baseUrl}}/recordings
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/recordings");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/recordings")
require "http/client"
url = "{{baseUrl}}/recordings"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/recordings"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/recordings");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/recordings"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/recordings HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/recordings")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/recordings"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/recordings")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/recordings")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/recordings');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/recordings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/recordings';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/recordings',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/recordings")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/recordings',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/recordings'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/recordings');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/recordings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/recordings';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/recordings"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/recordings" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/recordings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/recordings');
echo $response->getBody();
setUrl('{{baseUrl}}/recordings');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/recordings');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/recordings' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/recordings' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/recordings")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/recordings"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/recordings"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/recordings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/recordings') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/recordings";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/recordings
http GET {{baseUrl}}/recordings
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/recordings
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/recordings")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"call_leg_id": "11111111-5717-4562-b3fc-2c963f66afa6",
"call_session_id": "22222222-5717-4562-b3fc-2c963f66afa6",
"channels": "single",
"conference_id": "41b9acd4-f4da-4ff5-a85c-e07e90b53f46",
"created_at": "2019-03-29T13:10:00Z",
"download_urls": {
"mp3": "https://s3.amazonaws.com/some/path"
},
"duration_millis": 50000,
"id": "dfadada7-af74-47bc-83a4-554275f55f5c",
"record_type": "recording",
"recording_ended_at": "2019-03-29T12:10:00Z",
"recording_started_at": "2019-03-29T11:10:00Z",
"source": "conference",
"status": "completed",
"updated_at": "2019-03-29T14:10:00Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a recording
{{baseUrl}}/recordings/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/recordings/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/recordings/:id")
require "http/client"
url = "{{baseUrl}}/recordings/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/recordings/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/recordings/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/recordings/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/recordings/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/recordings/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/recordings/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/recordings/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/recordings/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/recordings/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/recordings/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/recordings/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/recordings/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/recordings/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/recordings/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/recordings/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/recordings/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/recordings/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/recordings/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/recordings/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/recordings/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/recordings/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/recordings/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/recordings/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/recordings/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/recordings/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/recordings/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/recordings/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/recordings/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/recordings/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/recordings/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/recordings/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/recordings/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/recordings/:id
http GET {{baseUrl}}/recordings/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/recordings/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/recordings/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_leg_id": "11111111-5717-4562-b3fc-2c963f66afa6",
"call_session_id": "22222222-5717-4562-b3fc-2c963f66afa6",
"channels": "single",
"conference_id": "41b9acd4-f4da-4ff5-a85c-e07e90b53f46",
"created_at": "2019-03-29T13:10:00Z",
"download_urls": {
"mp3": "https://s3.amazonaws.com/some/path"
},
"duration_millis": 50000,
"id": "dfadada7-af74-47bc-83a4-554275f55f5c",
"record_type": "recording",
"recording_ended_at": "2019-03-29T12:10:00Z",
"recording_started_at": "2019-03-29T11:10:00Z",
"source": "conference",
"status": "completed",
"updated_at": "2019-03-29T14:10:00Z"
}
}
POST
Create a Wireless Detail Records (WDRs) Report
{{baseUrl}}/wireless/detail_records_reports
BODY json
{
"end_time": "",
"start_time": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/wireless/detail_records_reports");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/wireless/detail_records_reports" {:content-type :json
:form-params {:end_time ""
:start_time ""}})
require "http/client"
url = "{{baseUrl}}/wireless/detail_records_reports"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/wireless/detail_records_reports"),
Content = new StringContent("{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/wireless/detail_records_reports");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/wireless/detail_records_reports"
payload := strings.NewReader("{\n \"end_time\": \"\",\n \"start_time\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/wireless/detail_records_reports HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 40
{
"end_time": "",
"start_time": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/wireless/detail_records_reports")
.setHeader("content-type", "application/json")
.setBody("{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/wireless/detail_records_reports"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/wireless/detail_records_reports")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/wireless/detail_records_reports")
.header("content-type", "application/json")
.body("{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}")
.asString();
const data = JSON.stringify({
end_time: '',
start_time: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/wireless/detail_records_reports');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/wireless/detail_records_reports',
headers: {'content-type': 'application/json'},
data: {end_time: '', start_time: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/wireless/detail_records_reports';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"end_time":"","start_time":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/wireless/detail_records_reports',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "end_time": "",\n "start_time": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/wireless/detail_records_reports")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/wireless/detail_records_reports',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({end_time: '', start_time: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/wireless/detail_records_reports',
headers: {'content-type': 'application/json'},
body: {end_time: '', start_time: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/wireless/detail_records_reports');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
end_time: '',
start_time: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/wireless/detail_records_reports',
headers: {'content-type': 'application/json'},
data: {end_time: '', start_time: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/wireless/detail_records_reports';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"end_time":"","start_time":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"end_time": @"",
@"start_time": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/wireless/detail_records_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/wireless/detail_records_reports" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/wireless/detail_records_reports",
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([
'end_time' => '',
'start_time' => ''
]),
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;
}
request('POST', '{{baseUrl}}/wireless/detail_records_reports', [
'body' => '{
"end_time": "",
"start_time": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/wireless/detail_records_reports');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'end_time' => '',
'start_time' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'end_time' => '',
'start_time' => ''
]));
$request->setRequestUrl('{{baseUrl}}/wireless/detail_records_reports');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/wireless/detail_records_reports' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"end_time": "",
"start_time": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/wireless/detail_records_reports' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"end_time": "",
"start_time": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/wireless/detail_records_reports", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/wireless/detail_records_reports"
payload = {
"end_time": "",
"start_time": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/wireless/detail_records_reports"
payload <- "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/wireless/detail_records_reports")
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 \"end_time\": \"\",\n \"start_time\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/wireless/detail_records_reports') do |req|
req.body = "{\n \"end_time\": \"\",\n \"start_time\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/wireless/detail_records_reports";
let payload = json!({
"end_time": "",
"start_time": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/wireless/detail_records_reports \
--header 'content-type: application/json' \
--data '{
"end_time": "",
"start_time": ""
}'
echo '{
"end_time": "",
"start_time": ""
}' | \
http POST {{baseUrl}}/wireless/detail_records_reports \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "end_time": "",\n "start_time": ""\n}' \
--output-document \
- {{baseUrl}}/wireless/detail_records_reports
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"end_time": "",
"start_time": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/wireless/detail_records_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"end_time": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "detail_records_report",
"report_url": "http://example.com",
"start_time": "2018-02-02T22:25:27.521Z",
"status": "pending",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
DELETE
Delete a Wireless Detail Record (WDR) Report
{{baseUrl}}/wireless/detail_records_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/wireless/detail_records_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/wireless/detail_records_reports/:id")
require "http/client"
url = "{{baseUrl}}/wireless/detail_records_reports/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/wireless/detail_records_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/wireless/detail_records_reports/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/wireless/detail_records_reports/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/wireless/detail_records_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/wireless/detail_records_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/wireless/detail_records_reports/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/wireless/detail_records_reports/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/wireless/detail_records_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/wireless/detail_records_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/wireless/detail_records_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/wireless/detail_records_reports/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/wireless/detail_records_reports/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/wireless/detail_records_reports/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/wireless/detail_records_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/wireless/detail_records_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/wireless/detail_records_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/wireless/detail_records_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/wireless/detail_records_reports/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/wireless/detail_records_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/wireless/detail_records_reports/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/wireless/detail_records_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/wireless/detail_records_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/wireless/detail_records_reports/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/wireless/detail_records_reports/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/wireless/detail_records_reports/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/wireless/detail_records_reports/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/wireless/detail_records_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/wireless/detail_records_reports/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/wireless/detail_records_reports/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/wireless/detail_records_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/wireless/detail_records_reports/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/wireless/detail_records_reports/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/wireless/detail_records_reports/:id
http DELETE {{baseUrl}}/wireless/detail_records_reports/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/wireless/detail_records_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/wireless/detail_records_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"end_time": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "detail_records_report",
"report_url": "http://example.com",
"start_time": "2018-02-02T22:25:27.521Z",
"status": "pending",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get a Wireless Detail Record (WDR) Report
{{baseUrl}}/wireless/detail_records_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/wireless/detail_records_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/wireless/detail_records_reports/:id")
require "http/client"
url = "{{baseUrl}}/wireless/detail_records_reports/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/wireless/detail_records_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/wireless/detail_records_reports/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/wireless/detail_records_reports/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/wireless/detail_records_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/wireless/detail_records_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/wireless/detail_records_reports/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/wireless/detail_records_reports/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/wireless/detail_records_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/wireless/detail_records_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/wireless/detail_records_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/wireless/detail_records_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/wireless/detail_records_reports/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/wireless/detail_records_reports/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/wireless/detail_records_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/wireless/detail_records_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/wireless/detail_records_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/wireless/detail_records_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/wireless/detail_records_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/wireless/detail_records_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/wireless/detail_records_reports/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/wireless/detail_records_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/wireless/detail_records_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/wireless/detail_records_reports/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/wireless/detail_records_reports/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/wireless/detail_records_reports/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/wireless/detail_records_reports/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/wireless/detail_records_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/wireless/detail_records_reports/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/wireless/detail_records_reports/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/wireless/detail_records_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/wireless/detail_records_reports/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/wireless/detail_records_reports/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/wireless/detail_records_reports/:id
http GET {{baseUrl}}/wireless/detail_records_reports/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/wireless/detail_records_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/wireless/detail_records_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"end_time": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "detail_records_report",
"report_url": "http://example.com",
"start_time": "2018-02-02T22:25:27.521Z",
"status": "pending",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get all Wireless Detail Records (WDRs) Reports
{{baseUrl}}/wireless/detail_records_reports
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/wireless/detail_records_reports");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/wireless/detail_records_reports")
require "http/client"
url = "{{baseUrl}}/wireless/detail_records_reports"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/wireless/detail_records_reports"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/wireless/detail_records_reports");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/wireless/detail_records_reports"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/wireless/detail_records_reports HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/wireless/detail_records_reports")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/wireless/detail_records_reports"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/wireless/detail_records_reports")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/wireless/detail_records_reports")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/wireless/detail_records_reports');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/wireless/detail_records_reports'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/wireless/detail_records_reports';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/wireless/detail_records_reports',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/wireless/detail_records_reports")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/wireless/detail_records_reports',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/wireless/detail_records_reports'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/wireless/detail_records_reports');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/wireless/detail_records_reports'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/wireless/detail_records_reports';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/wireless/detail_records_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/wireless/detail_records_reports" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/wireless/detail_records_reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/wireless/detail_records_reports');
echo $response->getBody();
setUrl('{{baseUrl}}/wireless/detail_records_reports');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/wireless/detail_records_reports');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/wireless/detail_records_reports' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/wireless/detail_records_reports' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/wireless/detail_records_reports")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/wireless/detail_records_reports"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/wireless/detail_records_reports"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/wireless/detail_records_reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/wireless/detail_records_reports') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/wireless/detail_records_reports";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/wireless/detail_records_reports
http GET {{baseUrl}}/wireless/detail_records_reports
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/wireless/detail_records_reports
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/wireless/detail_records_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Create a ledger billing group report
{{baseUrl}}/ledger_billing_group_reports
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ledger_billing_group_reports");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/ledger_billing_group_reports")
require "http/client"
url = "{{baseUrl}}/ledger_billing_group_reports"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/ledger_billing_group_reports"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ledger_billing_group_reports");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ledger_billing_group_reports"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/ledger_billing_group_reports HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/ledger_billing_group_reports")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ledger_billing_group_reports"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ledger_billing_group_reports")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/ledger_billing_group_reports")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/ledger_billing_group_reports');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/ledger_billing_group_reports'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ledger_billing_group_reports';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ledger_billing_group_reports',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ledger_billing_group_reports")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/ledger_billing_group_reports',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/ledger_billing_group_reports'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/ledger_billing_group_reports');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/ledger_billing_group_reports'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ledger_billing_group_reports';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ledger_billing_group_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ledger_billing_group_reports" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ledger_billing_group_reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/ledger_billing_group_reports');
echo $response->getBody();
setUrl('{{baseUrl}}/ledger_billing_group_reports');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ledger_billing_group_reports');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ledger_billing_group_reports' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ledger_billing_group_reports' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/ledger_billing_group_reports", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ledger_billing_group_reports"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ledger_billing_group_reports"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ledger_billing_group_reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/ledger_billing_group_reports') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ledger_billing_group_reports";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/ledger_billing_group_reports
http POST {{baseUrl}}/ledger_billing_group_reports
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/ledger_billing_group_reports
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ledger_billing_group_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-10-15T10:07:15.527Z",
"id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"organization_id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"record_type": "ledger_billing_group_report",
"report_url": "https://example.com",
"updated_at": "2019-10-15T10:07:15.527Z"
}
}
GET
Retrieve a ledger billing group report
{{baseUrl}}/ledger_billing_group_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/ledger_billing_group_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/ledger_billing_group_reports/:id")
require "http/client"
url = "{{baseUrl}}/ledger_billing_group_reports/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/ledger_billing_group_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/ledger_billing_group_reports/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/ledger_billing_group_reports/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/ledger_billing_group_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/ledger_billing_group_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/ledger_billing_group_reports/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/ledger_billing_group_reports/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/ledger_billing_group_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/ledger_billing_group_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/ledger_billing_group_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/ledger_billing_group_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/ledger_billing_group_reports/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/ledger_billing_group_reports/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/ledger_billing_group_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/ledger_billing_group_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/ledger_billing_group_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/ledger_billing_group_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/ledger_billing_group_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/ledger_billing_group_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/ledger_billing_group_reports/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/ledger_billing_group_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/ledger_billing_group_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/ledger_billing_group_reports/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/ledger_billing_group_reports/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/ledger_billing_group_reports/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/ledger_billing_group_reports/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/ledger_billing_group_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/ledger_billing_group_reports/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/ledger_billing_group_reports/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/ledger_billing_group_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/ledger_billing_group_reports/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/ledger_billing_group_reports/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/ledger_billing_group_reports/:id
http GET {{baseUrl}}/ledger_billing_group_reports/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/ledger_billing_group_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/ledger_billing_group_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2019-10-15T10:07:15.527Z",
"id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"organization_id": "f5586561-8ff0-4291-a0ac-84fe544797bd",
"record_type": "ledger_billing_group_report",
"report_url": "https://example.com",
"updated_at": "2019-10-15T10:07:15.527Z"
}
}
GET
List all requirement types
{{baseUrl}}/requirement_types
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/requirement_types");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/requirement_types")
require "http/client"
url = "{{baseUrl}}/requirement_types"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/requirement_types"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/requirement_types");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/requirement_types"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/requirement_types HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/requirement_types")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/requirement_types"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/requirement_types")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/requirement_types")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/requirement_types');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/requirement_types'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/requirement_types';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/requirement_types',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/requirement_types")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/requirement_types',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/requirement_types'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/requirement_types');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/requirement_types'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/requirement_types';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/requirement_types"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/requirement_types" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/requirement_types",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/requirement_types');
echo $response->getBody();
setUrl('{{baseUrl}}/requirement_types');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/requirement_types');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/requirement_types' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/requirement_types' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/requirement_types")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/requirement_types"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/requirement_types"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/requirement_types")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/requirement_types') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/requirement_types";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/requirement_types
http GET {{baseUrl}}/requirement_types
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/requirement_types
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/requirement_types")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a requirement types
{{baseUrl}}/requirement_types/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/requirement_types/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/requirement_types/:id")
require "http/client"
url = "{{baseUrl}}/requirement_types/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/requirement_types/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/requirement_types/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/requirement_types/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/requirement_types/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/requirement_types/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/requirement_types/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/requirement_types/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/requirement_types/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/requirement_types/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/requirement_types/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/requirement_types/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/requirement_types/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/requirement_types/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/requirement_types/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/requirement_types/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/requirement_types/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/requirement_types/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/requirement_types/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/requirement_types/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/requirement_types/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/requirement_types/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/requirement_types/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/requirement_types/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/requirement_types/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/requirement_types/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/requirement_types/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/requirement_types/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/requirement_types/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/requirement_types/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/requirement_types/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/requirement_types/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/requirement_types/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/requirement_types/:id
http GET {{baseUrl}}/requirement_types/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/requirement_types/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/requirement_types/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2021-04-09T22:25:27.521Z",
"description": "Proves the customer has a physical address in the same locality as the phone number",
"example": "Utility bill, internet bill, phone bill, or lease",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "Proof of Address",
"record_type": "requirement_type",
"type": "document",
"updated_at": "2021-04-12T20:20:20.020Z"
}
}
GET
List all requirements
{{baseUrl}}/requirements
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/requirements");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/requirements")
require "http/client"
url = "{{baseUrl}}/requirements"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/requirements"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/requirements");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/requirements"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/requirements HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/requirements")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/requirements"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/requirements")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/requirements")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/requirements');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/requirements'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/requirements';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/requirements',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/requirements")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/requirements',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/requirements'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/requirements');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/requirements'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/requirements';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/requirements"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/requirements" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/requirements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/requirements');
echo $response->getBody();
setUrl('{{baseUrl}}/requirements');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/requirements');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/requirements' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/requirements' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/requirements")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/requirements"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/requirements"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/requirements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/requirements') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/requirements";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/requirements
http GET {{baseUrl}}/requirements
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/requirements
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/requirements")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a document requirement
{{baseUrl}}/requirements/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/requirements/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/requirements/:id")
require "http/client"
url = "{{baseUrl}}/requirements/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/requirements/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/requirements/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/requirements/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/requirements/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/requirements/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/requirements/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/requirements/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/requirements/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/requirements/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/requirements/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/requirements/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/requirements/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/requirements/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/requirements/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/requirements/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/requirements/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/requirements/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/requirements/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/requirements/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/requirements/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/requirements/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/requirements/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/requirements/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/requirements/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/requirements/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/requirements/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/requirements/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/requirements/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/requirements/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/requirements/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/requirements/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/requirements/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/requirements/:id
http GET {{baseUrl}}/requirements/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/requirements/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/requirements/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"action": "ordering",
"country_code": "FR",
"created_at": "2021-04-09T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"locality": "Nice",
"phone_number_type": "local",
"record_type": "requirement",
"updated_at": "2021-04-12T20:20:20.020Z"
}
}
GET
View a list of room participants.
{{baseUrl}}/room_participants
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/room_participants");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/room_participants")
require "http/client"
url = "{{baseUrl}}/room_participants"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/room_participants"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/room_participants");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/room_participants"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/room_participants HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/room_participants")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/room_participants"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/room_participants")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/room_participants")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/room_participants');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/room_participants'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/room_participants';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/room_participants',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/room_participants")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/room_participants',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/room_participants'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/room_participants');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/room_participants'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/room_participants';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/room_participants"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/room_participants" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/room_participants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/room_participants');
echo $response->getBody();
setUrl('{{baseUrl}}/room_participants');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/room_participants');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/room_participants' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/room_participants' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/room_participants")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/room_participants"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/room_participants"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/room_participants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/room_participants') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/room_participants";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/room_participants
http GET {{baseUrl}}/room_participants
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/room_participants
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/room_participants")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"context": "Alice",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"joined_at": "2021-04-16T09:46:20.954863Z",
"left_at": "2021-04-16T10:24:55.962200Z",
"record_type": "room_participant",
"session_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
View a room participant.
{{baseUrl}}/room_participants/:room_participant_id
QUERY PARAMS
room_participant_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/room_participants/:room_participant_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/room_participants/:room_participant_id")
require "http/client"
url = "{{baseUrl}}/room_participants/:room_participant_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/room_participants/:room_participant_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/room_participants/:room_participant_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/room_participants/:room_participant_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/room_participants/:room_participant_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/room_participants/:room_participant_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/room_participants/:room_participant_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/room_participants/:room_participant_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/room_participants/:room_participant_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/room_participants/:room_participant_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/room_participants/:room_participant_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/room_participants/:room_participant_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/room_participants/:room_participant_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/room_participants/:room_participant_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/room_participants/:room_participant_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/room_participants/:room_participant_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/room_participants/:room_participant_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/room_participants/:room_participant_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/room_participants/:room_participant_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/room_participants/:room_participant_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/room_participants/:room_participant_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/room_participants/:room_participant_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/room_participants/:room_participant_id');
echo $response->getBody();
setUrl('{{baseUrl}}/room_participants/:room_participant_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/room_participants/:room_participant_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/room_participants/:room_participant_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/room_participants/:room_participant_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/room_participants/:room_participant_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/room_participants/:room_participant_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/room_participants/:room_participant_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/room_participants/:room_participant_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/room_participants/:room_participant_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/room_participants/:room_participant_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/room_participants/:room_participant_id
http GET {{baseUrl}}/room_participants/:room_participant_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/room_participants/:room_participant_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/room_participants/:room_participant_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"context": "Alice",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"joined_at": "2021-04-16T09:46:20.954863Z",
"left_at": "2021-04-16T10:24:55.962200Z",
"record_type": "room_participant",
"session_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
}
GET
View a list of room participants. (GET)
{{baseUrl}}/room_sessions/:room_session_id/participants
QUERY PARAMS
room_session_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/room_sessions/:room_session_id/participants");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/room_sessions/:room_session_id/participants")
require "http/client"
url = "{{baseUrl}}/room_sessions/:room_session_id/participants"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/room_sessions/:room_session_id/participants"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/room_sessions/:room_session_id/participants");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/room_sessions/:room_session_id/participants"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/room_sessions/:room_session_id/participants HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/room_sessions/:room_session_id/participants")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/room_sessions/:room_session_id/participants"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/room_sessions/:room_session_id/participants")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/room_sessions/:room_session_id/participants")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/room_sessions/:room_session_id/participants');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/room_sessions/:room_session_id/participants'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/room_sessions/:room_session_id/participants';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/room_sessions/:room_session_id/participants',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/room_sessions/:room_session_id/participants")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/room_sessions/:room_session_id/participants',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/room_sessions/:room_session_id/participants'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/room_sessions/:room_session_id/participants');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/room_sessions/:room_session_id/participants'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/room_sessions/:room_session_id/participants';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/room_sessions/:room_session_id/participants"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/room_sessions/:room_session_id/participants" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/room_sessions/:room_session_id/participants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/room_sessions/:room_session_id/participants');
echo $response->getBody();
setUrl('{{baseUrl}}/room_sessions/:room_session_id/participants');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/room_sessions/:room_session_id/participants');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/room_sessions/:room_session_id/participants' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/room_sessions/:room_session_id/participants' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/room_sessions/:room_session_id/participants")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/room_sessions/:room_session_id/participants"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/room_sessions/:room_session_id/participants"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/room_sessions/:room_session_id/participants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/room_sessions/:room_session_id/participants') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/room_sessions/:room_session_id/participants";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/room_sessions/:room_session_id/participants
http GET {{baseUrl}}/room_sessions/:room_session_id/participants
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/room_sessions/:room_session_id/participants
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/room_sessions/:room_session_id/participants")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"context": "Alice",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"joined_at": "2021-04-16T09:46:20.954863Z",
"left_at": "2021-04-16T10:24:55.962200Z",
"record_type": "room_participant",
"session_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
View a list of room sessions.
{{baseUrl}}/room_sessions
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/room_sessions");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/room_sessions")
require "http/client"
url = "{{baseUrl}}/room_sessions"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/room_sessions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/room_sessions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/room_sessions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/room_sessions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/room_sessions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/room_sessions"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/room_sessions")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/room_sessions")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/room_sessions');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/room_sessions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/room_sessions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/room_sessions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/room_sessions")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/room_sessions',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/room_sessions'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/room_sessions');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/room_sessions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/room_sessions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/room_sessions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/room_sessions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/room_sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/room_sessions');
echo $response->getBody();
setUrl('{{baseUrl}}/room_sessions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/room_sessions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/room_sessions' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/room_sessions' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/room_sessions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/room_sessions"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/room_sessions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/room_sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/room_sessions') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/room_sessions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/room_sessions
http GET {{baseUrl}}/room_sessions
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/room_sessions
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/room_sessions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": false,
"created_at": "2021-04-16T09:46:20.954863Z",
"ended_at": "2021-04-16T10:24:55.962200Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"participants": [],
"record_type": "room_session",
"room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
View a room session.
{{baseUrl}}/room_sessions/:room_session_id
QUERY PARAMS
room_session_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/room_sessions/:room_session_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/room_sessions/:room_session_id")
require "http/client"
url = "{{baseUrl}}/room_sessions/:room_session_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/room_sessions/:room_session_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/room_sessions/:room_session_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/room_sessions/:room_session_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/room_sessions/:room_session_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/room_sessions/:room_session_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/room_sessions/:room_session_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/room_sessions/:room_session_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/room_sessions/:room_session_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/room_sessions/:room_session_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/room_sessions/:room_session_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/room_sessions/:room_session_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/room_sessions/:room_session_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/room_sessions/:room_session_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/room_sessions/:room_session_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/room_sessions/:room_session_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/room_sessions/:room_session_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/room_sessions/:room_session_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/room_sessions/:room_session_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/room_sessions/:room_session_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/room_sessions/:room_session_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/room_sessions/:room_session_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/room_sessions/:room_session_id');
echo $response->getBody();
setUrl('{{baseUrl}}/room_sessions/:room_session_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/room_sessions/:room_session_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/room_sessions/:room_session_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/room_sessions/:room_session_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/room_sessions/:room_session_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/room_sessions/:room_session_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/room_sessions/:room_session_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/room_sessions/:room_session_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/room_sessions/:room_session_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/room_sessions/:room_session_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/room_sessions/:room_session_id
http GET {{baseUrl}}/room_sessions/:room_session_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/room_sessions/:room_session_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/room_sessions/:room_session_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"created_at": "2021-04-16T09:46:20.954863Z",
"ended_at": "2021-04-16T10:24:55.962200Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"participants": [],
"record_type": "room_session",
"room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
}
POST
Create a room.
{{baseUrl}}/rooms
BODY json
{
"max_participants": 0,
"unique_name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rooms");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/rooms" {:content-type :json
:form-params {:max_participants 0
:unique_name ""}})
require "http/client"
url = "{{baseUrl}}/rooms"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/rooms"),
Content = new StringContent("{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rooms");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rooms"
payload := strings.NewReader("{\n \"max_participants\": 0,\n \"unique_name\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/rooms HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 48
{
"max_participants": 0,
"unique_name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/rooms")
.setHeader("content-type", "application/json")
.setBody("{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rooms"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/rooms")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/rooms")
.header("content-type", "application/json")
.body("{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}")
.asString();
const data = JSON.stringify({
max_participants: 0,
unique_name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/rooms');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms',
headers: {'content-type': 'application/json'},
data: {max_participants: 0, unique_name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rooms';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"max_participants":0,"unique_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/rooms',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "max_participants": 0,\n "unique_name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/rooms")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/rooms',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({max_participants: 0, unique_name: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms',
headers: {'content-type': 'application/json'},
body: {max_participants: 0, unique_name: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/rooms');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
max_participants: 0,
unique_name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms',
headers: {'content-type': 'application/json'},
data: {max_participants: 0, unique_name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rooms';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"max_participants":0,"unique_name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"max_participants": @0,
@"unique_name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rooms"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/rooms" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rooms",
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([
'max_participants' => 0,
'unique_name' => ''
]),
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;
}
request('POST', '{{baseUrl}}/rooms', [
'body' => '{
"max_participants": 0,
"unique_name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/rooms');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'max_participants' => 0,
'unique_name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'max_participants' => 0,
'unique_name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/rooms');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rooms' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"max_participants": 0,
"unique_name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rooms' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"max_participants": 0,
"unique_name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/rooms", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rooms"
payload = {
"max_participants": 0,
"unique_name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rooms"
payload <- "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rooms")
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 \"max_participants\": 0,\n \"unique_name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/rooms') do |req|
req.body = "{\n \"max_participants\": 0,\n \"unique_name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rooms";
let payload = json!({
"max_participants": 0,
"unique_name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/rooms \
--header 'content-type: application/json' \
--data '{
"max_participants": 0,
"unique_name": ""
}'
echo '{
"max_participants": 0,
"unique_name": ""
}' | \
http POST {{baseUrl}}/rooms \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "max_participants": 0,\n "unique_name": ""\n}' \
--output-document \
- {{baseUrl}}/rooms
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"max_participants": 0,
"unique_name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rooms")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
"created_at": "2021-04-16T09:46:20.954863Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"max_participants": 50,
"record_type": "room",
"sessions": [
{
"active": true,
"created_at": "2021-04-16T09:46:20.954863Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
"participants": [],
"record_type": "room_session",
"room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
],
"unique_name": "My Room",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
}
DELETE
Delete a room.
{{baseUrl}}/rooms/:room_id
QUERY PARAMS
room_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rooms/:room_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/rooms/:room_id")
require "http/client"
url = "{{baseUrl}}/rooms/:room_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/rooms/:room_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rooms/:room_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rooms/:room_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/rooms/:room_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/rooms/:room_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rooms/:room_id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/rooms/:room_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/rooms/:room_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/rooms/:room_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/rooms/:room_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rooms/:room_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/rooms/:room_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rooms/:room_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/rooms/:room_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/rooms/:room_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/rooms/:room_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/rooms/:room_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rooms/:room_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rooms/:room_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/rooms/:room_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rooms/:room_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/rooms/:room_id');
echo $response->getBody();
setUrl('{{baseUrl}}/rooms/:room_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rooms/:room_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rooms/:room_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rooms/:room_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/rooms/:room_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rooms/:room_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rooms/:room_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rooms/:room_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/rooms/:room_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rooms/:room_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/rooms/:room_id
http DELETE {{baseUrl}}/rooms/:room_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/rooms/:room_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rooms/:room_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
View a list of room sessions. (GET)
{{baseUrl}}/rooms/:room_id/sessions
QUERY PARAMS
room_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rooms/:room_id/sessions");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/rooms/:room_id/sessions")
require "http/client"
url = "{{baseUrl}}/rooms/:room_id/sessions"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/rooms/:room_id/sessions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rooms/:room_id/sessions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rooms/:room_id/sessions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/rooms/:room_id/sessions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/rooms/:room_id/sessions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rooms/:room_id/sessions"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/rooms/:room_id/sessions")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/rooms/:room_id/sessions")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/rooms/:room_id/sessions');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/rooms/:room_id/sessions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rooms/:room_id/sessions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/rooms/:room_id/sessions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rooms/:room_id/sessions")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/rooms/:room_id/sessions',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/rooms/:room_id/sessions'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/rooms/:room_id/sessions');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/rooms/:room_id/sessions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rooms/:room_id/sessions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rooms/:room_id/sessions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/rooms/:room_id/sessions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rooms/:room_id/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/rooms/:room_id/sessions');
echo $response->getBody();
setUrl('{{baseUrl}}/rooms/:room_id/sessions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rooms/:room_id/sessions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rooms/:room_id/sessions' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rooms/:room_id/sessions' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/rooms/:room_id/sessions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rooms/:room_id/sessions"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rooms/:room_id/sessions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rooms/:room_id/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/rooms/:room_id/sessions') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rooms/:room_id/sessions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/rooms/:room_id/sessions
http GET {{baseUrl}}/rooms/:room_id/sessions
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/rooms/:room_id/sessions
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rooms/:room_id/sessions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": false,
"created_at": "2021-04-16T09:46:20.954863Z",
"ended_at": "2021-04-16T10:24:55.962200Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"participants": [],
"record_type": "room_session",
"room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
View a list of rooms.
{{baseUrl}}/rooms
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rooms");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/rooms")
require "http/client"
url = "{{baseUrl}}/rooms"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/rooms"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rooms");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rooms"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/rooms HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/rooms")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rooms"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/rooms")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/rooms")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/rooms');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/rooms'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rooms';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/rooms',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rooms")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/rooms',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/rooms'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/rooms');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/rooms'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rooms';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rooms"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/rooms" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rooms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/rooms');
echo $response->getBody();
setUrl('{{baseUrl}}/rooms');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rooms');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rooms' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rooms' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/rooms")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rooms"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rooms"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rooms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/rooms') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rooms";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/rooms
http GET {{baseUrl}}/rooms
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/rooms
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rooms")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
"created_at": "2021-04-16T09:46:20.954863Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"max_participants": 50,
"record_type": "room",
"sessions": [
{
"active": true,
"created_at": "2021-04-16T09:46:20.954863Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
"participants": [],
"record_type": "room_session",
"room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
],
"unique_name": "My Room",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
View a room.
{{baseUrl}}/rooms/:room_id
QUERY PARAMS
room_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rooms/:room_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/rooms/:room_id")
require "http/client"
url = "{{baseUrl}}/rooms/:room_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/rooms/:room_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rooms/:room_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rooms/:room_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/rooms/:room_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/rooms/:room_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rooms/:room_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/rooms/:room_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/rooms/:room_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/rooms/:room_id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/rooms/:room_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rooms/:room_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/rooms/:room_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rooms/:room_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/rooms/:room_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/rooms/:room_id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/rooms/:room_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/rooms/:room_id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rooms/:room_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rooms/:room_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/rooms/:room_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rooms/:room_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/rooms/:room_id');
echo $response->getBody();
setUrl('{{baseUrl}}/rooms/:room_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rooms/:room_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rooms/:room_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rooms/:room_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/rooms/:room_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rooms/:room_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rooms/:room_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rooms/:room_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/rooms/:room_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rooms/:room_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/rooms/:room_id
http GET {{baseUrl}}/rooms/:room_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/rooms/:room_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rooms/:room_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
"created_at": "2021-04-16T09:46:20.954863Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"max_participants": 50,
"record_type": "room",
"sessions": [
{
"active": true,
"created_at": "2021-04-16T09:46:20.954863Z",
"id": "7b61621f-62e0-4aad-ab11-9fd19e272e74",
"participants": [],
"record_type": "room_session",
"room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
],
"unique_name": "My Room",
"updated_at": "2021-04-16T10:24:55.962200Z"
}
}
POST
Create Client Token to join a room.
{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token
QUERY PARAMS
room_id
BODY json
{
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token" {:content-type :json
:form-params {:refresh_token_ttl_secs 0
:token_ttl_secs 0}})
require "http/client"
url = "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token"),
Content = new StringContent("{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token"
payload := strings.NewReader("{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/rooms/:room_id/actions/generate_join_client_token HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 56
{
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token")
.setHeader("content-type", "application/json")
.setBody("{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token")
.header("content-type", "application/json")
.body("{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}")
.asString();
const data = JSON.stringify({
refresh_token_ttl_secs: 0,
token_ttl_secs: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token',
headers: {'content-type': 'application/json'},
data: {refresh_token_ttl_secs: 0, token_ttl_secs: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"refresh_token_ttl_secs":0,"token_ttl_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "refresh_token_ttl_secs": 0,\n "token_ttl_secs": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/rooms/:room_id/actions/generate_join_client_token',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({refresh_token_ttl_secs: 0, token_ttl_secs: 0}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token',
headers: {'content-type': 'application/json'},
body: {refresh_token_ttl_secs: 0, token_ttl_secs: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
refresh_token_ttl_secs: 0,
token_ttl_secs: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token',
headers: {'content-type': 'application/json'},
data: {refresh_token_ttl_secs: 0, token_ttl_secs: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"refresh_token_ttl_secs":0,"token_ttl_secs":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"refresh_token_ttl_secs": @0,
@"token_ttl_secs": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token",
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([
'refresh_token_ttl_secs' => 0,
'token_ttl_secs' => 0
]),
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;
}
request('POST', '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token', [
'body' => '{
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'refresh_token_ttl_secs' => 0,
'token_ttl_secs' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'refresh_token_ttl_secs' => 0,
'token_ttl_secs' => 0
]));
$request->setRequestUrl('{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/rooms/:room_id/actions/generate_join_client_token", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token"
payload = {
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token"
payload <- "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token")
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 \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/rooms/:room_id/actions/generate_join_client_token') do |req|
req.body = "{\n \"refresh_token_ttl_secs\": 0,\n \"token_ttl_secs\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token";
let payload = json!({
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/rooms/:room_id/actions/generate_join_client_token \
--header 'content-type: application/json' \
--data '{
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
}'
echo '{
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
}' | \
http POST {{baseUrl}}/rooms/:room_id/actions/generate_join_client_token \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "refresh_token_ttl_secs": 0,\n "token_ttl_secs": 0\n}' \
--output-document \
- {{baseUrl}}/rooms/:room_id/actions/generate_join_client_token
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"refresh_token_ttl_secs": 0,
"token_ttl_secs": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rooms/:room_id/actions/generate_join_client_token")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"refresh_token": "eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDkzNzA1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6ImQ3OWJlMzhjLWFkNTQtNGQ5ZC1hODc4LWExNjVjNTk0MGQwNyIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6InJlZnJlc2gifQ.FHsp7KlVXn1E5tTUiKZzmQ4of39gi57AakeQeqI0oAa8hzjFMVb0RGj-mxWTvHVen4GpgsUW_epqqaxK16viCA",
"refresh_token_expires_at": "2021-04-22T12:15:05Z",
"token": "eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA",
"token_expires_at": "2021-04-22T12:24:55Z"
}
}
POST
Refresh Client Token to join a room.
{{baseUrl}}/rooms/:room_id/actions/refresh_client_token
QUERY PARAMS
room_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token")
require "http/client"
url = "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/rooms/:room_id/actions/refresh_client_token"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rooms/:room_id/actions/refresh_client_token");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/rooms/:room_id/actions/refresh_client_token HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rooms/:room_id/actions/refresh_client_token"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/rooms/:room_id/actions/refresh_client_token")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/rooms/:room_id/actions/refresh_client_token")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rooms/:room_id/actions/refresh_client_token")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/rooms/:room_id/actions/refresh_client_token',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rooms/:room_id/actions/refresh_client_token"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rooms/:room_id/actions/refresh_client_token",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token');
echo $response->getBody();
setUrl('{{baseUrl}}/rooms/:room_id/actions/refresh_client_token');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rooms/:room_id/actions/refresh_client_token');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rooms/:room_id/actions/refresh_client_token' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/rooms/:room_id/actions/refresh_client_token")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rooms/:room_id/actions/refresh_client_token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/rooms/:room_id/actions/refresh_client_token') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/rooms/:room_id/actions/refresh_client_token
http POST {{baseUrl}}/rooms/:room_id/actions/refresh_client_token
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/rooms/:room_id/actions/refresh_client_token
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rooms/:room_id/actions/refresh_client_token")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List short codes
{{baseUrl}}/short_codes
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/short_codes");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/short_codes")
require "http/client"
url = "{{baseUrl}}/short_codes"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/short_codes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/short_codes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/short_codes"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/short_codes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/short_codes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/short_codes"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/short_codes")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/short_codes")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/short_codes');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/short_codes'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/short_codes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/short_codes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/short_codes")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/short_codes',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/short_codes'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/short_codes');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/short_codes'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/short_codes';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/short_codes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/short_codes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/short_codes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/short_codes');
echo $response->getBody();
setUrl('{{baseUrl}}/short_codes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/short_codes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/short_codes' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/short_codes' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/short_codes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/short_codes"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/short_codes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/short_codes")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/short_codes') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/short_codes";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/short_codes
http GET {{baseUrl}}/short_codes
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/short_codes
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/short_codes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"record_type": "short_code",
"short_code": "12345",
"updated_at": "2019-01-23T18:10:02.574Z"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a short code
{{baseUrl}}/short_codes/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/short_codes/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/short_codes/:id")
require "http/client"
url = "{{baseUrl}}/short_codes/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/short_codes/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/short_codes/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/short_codes/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/short_codes/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/short_codes/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/short_codes/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/short_codes/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/short_codes/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/short_codes/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/short_codes/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/short_codes/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/short_codes/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/short_codes/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/short_codes/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/short_codes/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/short_codes/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/short_codes/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/short_codes/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/short_codes/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/short_codes/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/short_codes/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/short_codes/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/short_codes/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/short_codes/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/short_codes/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/short_codes/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/short_codes/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/short_codes/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/short_codes/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/short_codes/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/short_codes/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/short_codes/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/short_codes/:id
http GET {{baseUrl}}/short_codes/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/short_codes/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/short_codes/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"record_type": "short_code",
"short_code": "12345",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
PATCH
Update short code
{{baseUrl}}/short_codes/:id
QUERY PARAMS
id
BODY json
{
"messaging_profile_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/short_codes/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"messaging_profile_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/short_codes/:id" {:content-type :json
:form-params {:messaging_profile_id ""}})
require "http/client"
url = "{{baseUrl}}/short_codes/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"messaging_profile_id\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/short_codes/:id"),
Content = new StringContent("{\n \"messaging_profile_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/short_codes/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"messaging_profile_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/short_codes/:id"
payload := strings.NewReader("{\n \"messaging_profile_id\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/short_codes/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 32
{
"messaging_profile_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/short_codes/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"messaging_profile_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/short_codes/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"messaging_profile_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"messaging_profile_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/short_codes/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/short_codes/:id")
.header("content-type", "application/json")
.body("{\n \"messaging_profile_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
messaging_profile_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/short_codes/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/short_codes/:id',
headers: {'content-type': 'application/json'},
data: {messaging_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/short_codes/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"messaging_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/short_codes/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "messaging_profile_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"messaging_profile_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/short_codes/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/short_codes/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({messaging_profile_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/short_codes/:id',
headers: {'content-type': 'application/json'},
body: {messaging_profile_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/short_codes/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
messaging_profile_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/short_codes/:id',
headers: {'content-type': 'application/json'},
data: {messaging_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/short_codes/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"messaging_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"messaging_profile_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/short_codes/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/short_codes/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"messaging_profile_id\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/short_codes/:id",
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([
'messaging_profile_id' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/short_codes/:id', [
'body' => '{
"messaging_profile_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/short_codes/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'messaging_profile_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'messaging_profile_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/short_codes/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/short_codes/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"messaging_profile_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/short_codes/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"messaging_profile_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"messaging_profile_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/short_codes/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/short_codes/:id"
payload = { "messaging_profile_id": "" }
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/short_codes/:id"
payload <- "{\n \"messaging_profile_id\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/short_codes/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"messaging_profile_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/short_codes/:id') do |req|
req.body = "{\n \"messaging_profile_id\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/short_codes/:id";
let payload = json!({"messaging_profile_id": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/short_codes/:id \
--header 'content-type: application/json' \
--data '{
"messaging_profile_id": ""
}'
echo '{
"messaging_profile_id": ""
}' | \
http PATCH {{baseUrl}}/short_codes/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "messaging_profile_id": ""\n}' \
--output-document \
- {{baseUrl}}/short_codes/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["messaging_profile_id": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/short_codes/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"country_code": "US",
"created_at": "2019-01-23T18:10:02.574Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"record_type": "short_code",
"short_code": "12345",
"updated_at": "2019-01-23T18:10:02.574Z"
}
}
GET
Get SIM card group action details
{{baseUrl}}/sim_card_group_actions/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_group_actions/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_card_group_actions/:id")
require "http/client"
url = "{{baseUrl}}/sim_card_group_actions/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_card_group_actions/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_group_actions/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_group_actions/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_card_group_actions/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_card_group_actions/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_group_actions/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_group_actions/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_card_group_actions/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_card_group_actions/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_group_actions/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_group_actions/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_group_actions/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_group_actions/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_group_actions/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_group_actions/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_card_group_actions/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_group_actions/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_group_actions/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_group_actions/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_group_actions/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_group_actions/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_card_group_actions/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_group_actions/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_card_group_actions/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_group_actions/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_group_actions/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_card_group_actions/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_group_actions/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_group_actions/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_group_actions/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_card_group_actions/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_group_actions/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_card_group_actions/:id
http GET {{baseUrl}}/sim_card_group_actions/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_card_group_actions/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_group_actions/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group_action",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "in-progress",
"type": "set_private_wireless_gateway",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
List SIM card group actions
{{baseUrl}}/sim_card_group_actions
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_group_actions");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_card_group_actions")
require "http/client"
url = "{{baseUrl}}/sim_card_group_actions"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_card_group_actions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_group_actions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_group_actions"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_card_group_actions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_card_group_actions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_group_actions"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_group_actions")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_card_group_actions")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_card_group_actions');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_group_actions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_group_actions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_group_actions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_group_actions")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_group_actions',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_group_actions'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_card_group_actions');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_group_actions'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_group_actions';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_group_actions"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_group_actions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_group_actions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_card_group_actions');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_group_actions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_card_group_actions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_group_actions' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_group_actions' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_card_group_actions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_group_actions"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_group_actions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_group_actions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_card_group_actions') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_group_actions";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_card_group_actions
http GET {{baseUrl}}/sim_card_group_actions
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_card_group_actions
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_group_actions")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Create a SIM card group
{{baseUrl}}/sim_card_groups
BODY json
{
"data_limit": 0,
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_groups");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"data_limit\": 0,\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_card_groups" {:content-type :json
:form-params {:data_limit 0
:name ""}})
require "http/client"
url = "{{baseUrl}}/sim_card_groups"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_card_groups"),
Content = new StringContent("{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_groups");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"data_limit\": 0,\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_groups"
payload := strings.NewReader("{\n \"data_limit\": 0,\n \"name\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_card_groups HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 35
{
"data_limit": 0,
"name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_card_groups")
.setHeader("content-type", "application/json")
.setBody("{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_groups"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"data_limit\": 0,\n \"name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"data_limit\": 0,\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_groups")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_card_groups")
.header("content-type", "application/json")
.body("{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
.asString();
const data = JSON.stringify({
data_limit: 0,
name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_card_groups');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups',
headers: {'content-type': 'application/json'},
data: {data_limit: 0, name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_groups';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"data_limit":0,"name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_groups',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "data_limit": 0,\n "name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_groups")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_groups',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({data_limit: 0, name: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups',
headers: {'content-type': 'application/json'},
body: {data_limit: 0, name: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_card_groups');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
data_limit: 0,
name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups',
headers: {'content-type': 'application/json'},
data: {data_limit: 0, name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_groups';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"data_limit":0,"name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"data_limit": @0,
@"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_groups"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_groups" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"data_limit\": 0,\n \"name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_groups",
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([
'data_limit' => 0,
'name' => ''
]),
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;
}
request('POST', '{{baseUrl}}/sim_card_groups', [
'body' => '{
"data_limit": 0,
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_groups');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'data_limit' => 0,
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'data_limit' => 0,
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/sim_card_groups');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_groups' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"data_limit": 0,
"name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_groups' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"data_limit": 0,
"name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/sim_card_groups", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_groups"
payload = {
"data_limit": 0,
"name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_groups"
payload <- "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_groups")
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 \"data_limit\": 0,\n \"name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/sim_card_groups') do |req|
req.body = "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_groups";
let payload = json!({
"data_limit": 0,
"name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_card_groups \
--header 'content-type: application/json' \
--data '{
"data_limit": 0,
"name": ""
}'
echo '{
"data_limit": 0,
"name": ""
}' | \
http POST {{baseUrl}}/sim_card_groups \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "data_limit": 0,\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/sim_card_groups
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"data_limit": 0,
"name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_groups")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
DELETE
Delete a SIM card group
{{baseUrl}}/sim_card_groups/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_groups/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/sim_card_groups/:id")
require "http/client"
url = "{{baseUrl}}/sim_card_groups/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/sim_card_groups/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_groups/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_groups/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/sim_card_groups/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/sim_card_groups/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_groups/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/sim_card_groups/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/sim_card_groups/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/sim_card_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_groups/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_groups/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_groups/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/sim_card_groups/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/sim_card_groups/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/sim_card_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_groups/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_groups/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_groups/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_groups/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/sim_card_groups/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_groups/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_card_groups/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_groups/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_groups/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/sim_card_groups/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_groups/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_groups/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_groups/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/sim_card_groups/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_groups/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/sim_card_groups/:id
http DELETE {{baseUrl}}/sim_card_groups/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/sim_card_groups/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_groups/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get SIM card group
{{baseUrl}}/sim_card_groups/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_groups/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_card_groups/:id")
require "http/client"
url = "{{baseUrl}}/sim_card_groups/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_card_groups/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_groups/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_groups/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_card_groups/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_card_groups/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_groups/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_card_groups/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_card_groups/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_groups/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_groups/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_groups/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_groups/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_card_groups/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_groups/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_groups/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_groups/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_groups/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_groups/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_card_groups/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_groups/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_card_groups/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_groups/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_groups/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_card_groups/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_groups/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_groups/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_groups/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_card_groups/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_groups/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_card_groups/:id
http GET {{baseUrl}}/sim_card_groups/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_card_groups/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_groups/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get all SIM card groups
{{baseUrl}}/sim_card_groups
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_groups");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_card_groups")
require "http/client"
url = "{{baseUrl}}/sim_card_groups"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_card_groups"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_groups");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_groups"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_card_groups HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_card_groups")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_groups"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_groups")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_card_groups")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_card_groups');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_groups';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_groups',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_groups")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_groups',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_groups'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_card_groups');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_groups';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_groups"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_groups" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_groups",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_card_groups');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_groups');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_card_groups');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_groups' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_groups' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_card_groups")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_groups"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_groups"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_card_groups') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_groups";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_card_groups
http GET {{baseUrl}}/sim_card_groups
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_card_groups
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_groups")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Request Private Wireless Gateway assignment for SIM card group
{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway
QUERY PARAMS
id
BODY json
{
"private_wireless_gateway_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"private_wireless_gateway_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway" {:content-type :json
:form-params {:private_wireless_gateway_id ""}})
require "http/client"
url = "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"private_wireless_gateway_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway"),
Content = new StringContent("{\n \"private_wireless_gateway_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"private_wireless_gateway_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway"
payload := strings.NewReader("{\n \"private_wireless_gateway_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_card_groups/:id/actions/set_private_wireless_gateway HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 39
{
"private_wireless_gateway_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway")
.setHeader("content-type", "application/json")
.setBody("{\n \"private_wireless_gateway_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"private_wireless_gateway_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"private_wireless_gateway_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway")
.header("content-type", "application/json")
.body("{\n \"private_wireless_gateway_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
private_wireless_gateway_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway',
headers: {'content-type': 'application/json'},
data: {private_wireless_gateway_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"private_wireless_gateway_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "private_wireless_gateway_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"private_wireless_gateway_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_groups/:id/actions/set_private_wireless_gateway',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({private_wireless_gateway_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway',
headers: {'content-type': 'application/json'},
body: {private_wireless_gateway_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
private_wireless_gateway_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway',
headers: {'content-type': 'application/json'},
data: {private_wireless_gateway_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"private_wireless_gateway_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"private_wireless_gateway_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"private_wireless_gateway_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway",
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([
'private_wireless_gateway_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway', [
'body' => '{
"private_wireless_gateway_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'private_wireless_gateway_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'private_wireless_gateway_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"private_wireless_gateway_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"private_wireless_gateway_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"private_wireless_gateway_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/sim_card_groups/:id/actions/set_private_wireless_gateway", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway"
payload = { "private_wireless_gateway_id": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway"
payload <- "{\n \"private_wireless_gateway_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway")
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 \"private_wireless_gateway_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/sim_card_groups/:id/actions/set_private_wireless_gateway') do |req|
req.body = "{\n \"private_wireless_gateway_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway";
let payload = json!({"private_wireless_gateway_id": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway \
--header 'content-type: application/json' \
--data '{
"private_wireless_gateway_id": ""
}'
echo '{
"private_wireless_gateway_id": ""
}' | \
http POST {{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "private_wireless_gateway_id": ""\n}' \
--output-document \
- {{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["private_wireless_gateway_id": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_groups/:id/actions/set_private_wireless_gateway")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group_action",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "in-progress",
"type": "set_private_wireless_gateway",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Request Private Wireless Gateway removal from SIM card group
{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway")
require "http/client"
url = "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_card_groups/:id/actions/remove_private_wireless_gateway HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_groups/:id/actions/remove_private_wireless_gateway',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/sim_card_groups/:id/actions/remove_private_wireless_gateway")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/sim_card_groups/:id/actions/remove_private_wireless_gateway') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway
http POST {{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_groups/:id/actions/remove_private_wireless_gateway")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group_action",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "in-progress",
"type": "set_private_wireless_gateway",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
PATCH
Update a SIM card group
{{baseUrl}}/sim_card_groups/:id
QUERY PARAMS
id
BODY json
{
"data_limit": 0,
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_groups/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"data_limit\": 0,\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/sim_card_groups/:id" {:content-type :json
:form-params {:data_limit 0
:name ""}})
require "http/client"
url = "{{baseUrl}}/sim_card_groups/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/sim_card_groups/:id"),
Content = new StringContent("{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_groups/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"data_limit\": 0,\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_groups/:id"
payload := strings.NewReader("{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/sim_card_groups/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 35
{
"data_limit": 0,
"name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/sim_card_groups/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_groups/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"data_limit\": 0,\n \"name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"data_limit\": 0,\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/sim_card_groups/:id")
.header("content-type", "application/json")
.body("{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
.asString();
const data = JSON.stringify({
data_limit: 0,
name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/sim_card_groups/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sim_card_groups/:id',
headers: {'content-type': 'application/json'},
data: {data_limit: 0, name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_groups/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"data_limit":0,"name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_groups/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "data_limit": 0,\n "name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"data_limit\": 0,\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_groups/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_groups/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({data_limit: 0, name: ''}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sim_card_groups/:id',
headers: {'content-type': 'application/json'},
body: {data_limit: 0, name: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/sim_card_groups/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
data_limit: 0,
name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sim_card_groups/:id',
headers: {'content-type': 'application/json'},
data: {data_limit: 0, name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_groups/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"data_limit":0,"name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"data_limit": @0,
@"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_groups/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_groups/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"data_limit\": 0,\n \"name\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_groups/:id",
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([
'data_limit' => 0,
'name' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/sim_card_groups/:id', [
'body' => '{
"data_limit": 0,
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_groups/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'data_limit' => 0,
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'data_limit' => 0,
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/sim_card_groups/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_groups/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"data_limit": 0,
"name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_groups/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"data_limit": 0,
"name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/sim_card_groups/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_groups/:id"
payload = {
"data_limit": 0,
"name": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_groups/:id"
payload <- "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_groups/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/sim_card_groups/:id') do |req|
req.body = "{\n \"data_limit\": 0,\n \"name\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_groups/:id";
let payload = json!({
"data_limit": 0,
"name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/sim_card_groups/:id \
--header 'content-type: application/json' \
--data '{
"data_limit": 0,
"name": ""
}'
echo '{
"data_limit": 0,
"name": ""
}' | \
http PATCH {{baseUrl}}/sim_card_groups/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "data_limit": 0,\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/sim_card_groups/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"data_limit": 0,
"name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_groups/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"data_limit": 2048,
"default": true,
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "My Test Group",
"private_wireless_gateway_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": "sim_card_group",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Create a SIM card order
{{baseUrl}}/sim_card_orders
BODY json
{
"address_id": "",
"quantity": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_orders");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"address_id\": \"\",\n \"quantity\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_card_orders" {:content-type :json
:form-params {:address_id ""
:quantity 0}})
require "http/client"
url = "{{baseUrl}}/sim_card_orders"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address_id\": \"\",\n \"quantity\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_card_orders"),
Content = new StringContent("{\n \"address_id\": \"\",\n \"quantity\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_orders");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address_id\": \"\",\n \"quantity\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_orders"
payload := strings.NewReader("{\n \"address_id\": \"\",\n \"quantity\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_card_orders HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 39
{
"address_id": "",
"quantity": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_card_orders")
.setHeader("content-type", "application/json")
.setBody("{\n \"address_id\": \"\",\n \"quantity\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_orders"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"address_id\": \"\",\n \"quantity\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"address_id\": \"\",\n \"quantity\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_orders")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_card_orders")
.header("content-type", "application/json")
.body("{\n \"address_id\": \"\",\n \"quantity\": 0\n}")
.asString();
const data = JSON.stringify({
address_id: '',
quantity: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_card_orders');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_orders',
headers: {'content-type': 'application/json'},
data: {address_id: '', quantity: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_orders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address_id":"","quantity":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_orders',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address_id": "",\n "quantity": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"address_id\": \"\",\n \"quantity\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_orders")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_orders',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({address_id: '', quantity: 0}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_orders',
headers: {'content-type': 'application/json'},
body: {address_id: '', quantity: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_card_orders');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address_id: '',
quantity: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_orders',
headers: {'content-type': 'application/json'},
data: {address_id: '', quantity: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_orders';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address_id":"","quantity":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"address_id": @"",
@"quantity": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_orders" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address_id\": \"\",\n \"quantity\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_orders",
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([
'address_id' => '',
'quantity' => 0
]),
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;
}
request('POST', '{{baseUrl}}/sim_card_orders', [
'body' => '{
"address_id": "",
"quantity": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_orders');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address_id' => '',
'quantity' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address_id' => '',
'quantity' => 0
]));
$request->setRequestUrl('{{baseUrl}}/sim_card_orders');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_orders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address_id": "",
"quantity": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_orders' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address_id": "",
"quantity": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address_id\": \"\",\n \"quantity\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/sim_card_orders", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_orders"
payload = {
"address_id": "",
"quantity": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_orders"
payload <- "{\n \"address_id\": \"\",\n \"quantity\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_orders")
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 \"address_id\": \"\",\n \"quantity\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/sim_card_orders') do |req|
req.body = "{\n \"address_id\": \"\",\n \"quantity\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_orders";
let payload = json!({
"address_id": "",
"quantity": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_card_orders \
--header 'content-type: application/json' \
--data '{
"address_id": "",
"quantity": 0
}'
echo '{
"address_id": "",
"quantity": 0
}' | \
http POST {{baseUrl}}/sim_card_orders \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "address_id": "",\n "quantity": 0\n}' \
--output-document \
- {{baseUrl}}/sim_card_orders
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address_id": "",
"quantity": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"cost": {
"amount": "2.52",
"currency": "USD"
},
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"order_address": {
"administrative_area": "IL",
"country_code": "US",
"extended_address": "Suite 504",
"id": "1293384261075731499",
"locality": "Chicago",
"postal_code": "60654",
"street_address": "311 W Superior St"
},
"quantity": 21,
"record_type": "sim_card_order",
"status": "pending",
"tracking_url": "http://www.example.com/",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get a single SIM card order
{{baseUrl}}/sim_card_orders/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_orders/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_card_orders/:id")
require "http/client"
url = "{{baseUrl}}/sim_card_orders/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_card_orders/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_orders/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_orders/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_card_orders/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_card_orders/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_orders/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_orders/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_card_orders/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_card_orders/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_orders/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_orders/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_orders/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_orders/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_orders/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_orders/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_card_orders/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_orders/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_orders/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_orders/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_orders/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_orders/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_card_orders/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_orders/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_card_orders/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_orders/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_orders/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_card_orders/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_orders/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_orders/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_orders/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_card_orders/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_orders/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_card_orders/:id
http GET {{baseUrl}}/sim_card_orders/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_card_orders/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_orders/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"cost": {
"amount": "2.52",
"currency": "USD"
},
"created_at": "2018-02-02T22:25:27.521Z",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"order_address": {
"administrative_area": "IL",
"country_code": "US",
"extended_address": "Suite 504",
"id": "1293384261075731499",
"locality": "Chicago",
"postal_code": "60654",
"street_address": "311 W Superior St"
},
"quantity": 21,
"record_type": "sim_card_order",
"status": "pending",
"tracking_url": "http://www.example.com/",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get all SIM card orders
{{baseUrl}}/sim_card_orders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_orders");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_card_orders")
require "http/client"
url = "{{baseUrl}}/sim_card_orders"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_card_orders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_orders");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_orders"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_card_orders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_card_orders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_orders"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_orders")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_card_orders")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_card_orders');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_orders',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_orders")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_orders',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_orders'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_card_orders');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sim_card_orders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_orders';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_orders"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_orders" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_orders",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_card_orders');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_orders');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_card_orders');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_orders' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_orders' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_card_orders")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_orders"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_orders"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_orders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_card_orders') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_orders";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_card_orders
http GET {{baseUrl}}/sim_card_orders
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_card_orders
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_orders")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Preview SIM card orders
{{baseUrl}}/sim_card_order_preview
BODY json
{
"address_id": "",
"quantity": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_card_order_preview");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"address_id\": \"\",\n \"quantity\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_card_order_preview" {:content-type :json
:form-params {:address_id ""
:quantity 0}})
require "http/client"
url = "{{baseUrl}}/sim_card_order_preview"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address_id\": \"\",\n \"quantity\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_card_order_preview"),
Content = new StringContent("{\n \"address_id\": \"\",\n \"quantity\": 0\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_card_order_preview");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address_id\": \"\",\n \"quantity\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_card_order_preview"
payload := strings.NewReader("{\n \"address_id\": \"\",\n \"quantity\": 0\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(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_card_order_preview HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 39
{
"address_id": "",
"quantity": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_card_order_preview")
.setHeader("content-type", "application/json")
.setBody("{\n \"address_id\": \"\",\n \"quantity\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_card_order_preview"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"address_id\": \"\",\n \"quantity\": 0\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"address_id\": \"\",\n \"quantity\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_card_order_preview")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_card_order_preview")
.header("content-type", "application/json")
.body("{\n \"address_id\": \"\",\n \"quantity\": 0\n}")
.asString();
const data = JSON.stringify({
address_id: '',
quantity: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_card_order_preview');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_order_preview',
headers: {'content-type': 'application/json'},
data: {address_id: '', quantity: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_card_order_preview';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address_id":"","quantity":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_card_order_preview',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address_id": "",\n "quantity": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"address_id\": \"\",\n \"quantity\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/sim_card_order_preview")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_card_order_preview',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({address_id: '', quantity: 0}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_order_preview',
headers: {'content-type': 'application/json'},
body: {address_id: '', quantity: 0},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_card_order_preview');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address_id: '',
quantity: 0
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_card_order_preview',
headers: {'content-type': 'application/json'},
data: {address_id: '', quantity: 0}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_card_order_preview';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address_id":"","quantity":0}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"address_id": @"",
@"quantity": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_card_order_preview"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_card_order_preview" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address_id\": \"\",\n \"quantity\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_card_order_preview",
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([
'address_id' => '',
'quantity' => 0
]),
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;
}
request('POST', '{{baseUrl}}/sim_card_order_preview', [
'body' => '{
"address_id": "",
"quantity": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sim_card_order_preview');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address_id' => '',
'quantity' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address_id' => '',
'quantity' => 0
]));
$request->setRequestUrl('{{baseUrl}}/sim_card_order_preview');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_card_order_preview' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address_id": "",
"quantity": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_card_order_preview' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address_id": "",
"quantity": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address_id\": \"\",\n \"quantity\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/sim_card_order_preview", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_card_order_preview"
payload = {
"address_id": "",
"quantity": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_card_order_preview"
payload <- "{\n \"address_id\": \"\",\n \"quantity\": 0\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_card_order_preview")
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 \"address_id\": \"\",\n \"quantity\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/sim_card_order_preview') do |req|
req.body = "{\n \"address_id\": \"\",\n \"quantity\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_card_order_preview";
let payload = json!({
"address_id": "",
"quantity": 0
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_card_order_preview \
--header 'content-type: application/json' \
--data '{
"address_id": "",
"quantity": 0
}'
echo '{
"address_id": "",
"quantity": 0
}' | \
http POST {{baseUrl}}/sim_card_order_preview \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "address_id": "",\n "quantity": 0\n}' \
--output-document \
- {{baseUrl}}/sim_card_order_preview
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address_id": "",
"quantity": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_card_order_preview")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"quantity": 21,
"record_type": "sim_card_order_preview"
}
}
PUT
Bulk Network Preferences for SIM cards
{{baseUrl}}/actions/network_preferences/sim_cards
BODY json
{
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
],
"sim_card_ids": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/actions/network_preferences/sim_cards");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/actions/network_preferences/sim_cards" {:content-type :json
:form-params {:sim_card_ids ["6b14e151-8493-4fa1-8664-1cc4e6d14158" "6b14e151-8493-4fa1-8664-1cc4e6d14158"]}})
require "http/client"
url = "{{baseUrl}}/actions/network_preferences/sim_cards"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/actions/network_preferences/sim_cards"),
Content = new StringContent("{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/actions/network_preferences/sim_cards");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/actions/network_preferences/sim_cards"
payload := strings.NewReader("{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}")
req, _ := http.NewRequest("PUT", 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(res)
fmt.Println(string(body))
}
PUT /baseUrl/actions/network_preferences/sim_cards HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 114
{
"sim_card_ids": [
"6b14e151-8493-4fa1-8664-1cc4e6d14158",
"6b14e151-8493-4fa1-8664-1cc4e6d14158"
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/actions/network_preferences/sim_cards")
.setHeader("content-type", "application/json")
.setBody("{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/actions/network_preferences/sim_cards"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/actions/network_preferences/sim_cards")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/actions/network_preferences/sim_cards")
.header("content-type", "application/json")
.body("{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}")
.asString();
const data = JSON.stringify({
sim_card_ids: [
'6b14e151-8493-4fa1-8664-1cc4e6d14158',
'6b14e151-8493-4fa1-8664-1cc4e6d14158'
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/actions/network_preferences/sim_cards');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/actions/network_preferences/sim_cards',
headers: {'content-type': 'application/json'},
data: {
sim_card_ids: ['6b14e151-8493-4fa1-8664-1cc4e6d14158', '6b14e151-8493-4fa1-8664-1cc4e6d14158']
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/actions/network_preferences/sim_cards';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"sim_card_ids":["6b14e151-8493-4fa1-8664-1cc4e6d14158","6b14e151-8493-4fa1-8664-1cc4e6d14158"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/actions/network_preferences/sim_cards',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "sim_card_ids": [\n "6b14e151-8493-4fa1-8664-1cc4e6d14158",\n "6b14e151-8493-4fa1-8664-1cc4e6d14158"\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/actions/network_preferences/sim_cards")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/actions/network_preferences/sim_cards',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
sim_card_ids: ['6b14e151-8493-4fa1-8664-1cc4e6d14158', '6b14e151-8493-4fa1-8664-1cc4e6d14158']
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/actions/network_preferences/sim_cards',
headers: {'content-type': 'application/json'},
body: {
sim_card_ids: ['6b14e151-8493-4fa1-8664-1cc4e6d14158', '6b14e151-8493-4fa1-8664-1cc4e6d14158']
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/actions/network_preferences/sim_cards');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
sim_card_ids: [
'6b14e151-8493-4fa1-8664-1cc4e6d14158',
'6b14e151-8493-4fa1-8664-1cc4e6d14158'
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/actions/network_preferences/sim_cards',
headers: {'content-type': 'application/json'},
data: {
sim_card_ids: ['6b14e151-8493-4fa1-8664-1cc4e6d14158', '6b14e151-8493-4fa1-8664-1cc4e6d14158']
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/actions/network_preferences/sim_cards';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"sim_card_ids":["6b14e151-8493-4fa1-8664-1cc4e6d14158","6b14e151-8493-4fa1-8664-1cc4e6d14158"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"sim_card_ids": @[ @"6b14e151-8493-4fa1-8664-1cc4e6d14158", @"6b14e151-8493-4fa1-8664-1cc4e6d14158" ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/actions/network_preferences/sim_cards"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/actions/network_preferences/sim_cards" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/actions/network_preferences/sim_cards",
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([
'sim_card_ids' => [
'6b14e151-8493-4fa1-8664-1cc4e6d14158',
'6b14e151-8493-4fa1-8664-1cc4e6d14158'
]
]),
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;
}
request('PUT', '{{baseUrl}}/actions/network_preferences/sim_cards', [
'body' => '{
"sim_card_ids": [
"6b14e151-8493-4fa1-8664-1cc4e6d14158",
"6b14e151-8493-4fa1-8664-1cc4e6d14158"
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/actions/network_preferences/sim_cards');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'sim_card_ids' => [
'6b14e151-8493-4fa1-8664-1cc4e6d14158',
'6b14e151-8493-4fa1-8664-1cc4e6d14158'
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'sim_card_ids' => [
'6b14e151-8493-4fa1-8664-1cc4e6d14158',
'6b14e151-8493-4fa1-8664-1cc4e6d14158'
]
]));
$request->setRequestUrl('{{baseUrl}}/actions/network_preferences/sim_cards');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/actions/network_preferences/sim_cards' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"sim_card_ids": [
"6b14e151-8493-4fa1-8664-1cc4e6d14158",
"6b14e151-8493-4fa1-8664-1cc4e6d14158"
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/actions/network_preferences/sim_cards' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"sim_card_ids": [
"6b14e151-8493-4fa1-8664-1cc4e6d14158",
"6b14e151-8493-4fa1-8664-1cc4e6d14158"
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/actions/network_preferences/sim_cards", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/actions/network_preferences/sim_cards"
payload = { "sim_card_ids": ["6b14e151-8493-4fa1-8664-1cc4e6d14158", "6b14e151-8493-4fa1-8664-1cc4e6d14158"] }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/actions/network_preferences/sim_cards"
payload <- "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/actions/network_preferences/sim_cards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/actions/network_preferences/sim_cards') do |req|
req.body = "{\n \"sim_card_ids\": [\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\",\n \"6b14e151-8493-4fa1-8664-1cc4e6d14158\"\n ]\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/actions/network_preferences/sim_cards";
let payload = json!({"sim_card_ids": ("6b14e151-8493-4fa1-8664-1cc4e6d14158", "6b14e151-8493-4fa1-8664-1cc4e6d14158")});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/actions/network_preferences/sim_cards \
--header 'content-type: application/json' \
--data '{
"sim_card_ids": [
"6b14e151-8493-4fa1-8664-1cc4e6d14158",
"6b14e151-8493-4fa1-8664-1cc4e6d14158"
]
}'
echo '{
"sim_card_ids": [
"6b14e151-8493-4fa1-8664-1cc4e6d14158",
"6b14e151-8493-4fa1-8664-1cc4e6d14158"
]
}' | \
http PUT {{baseUrl}}/actions/network_preferences/sim_cards \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "sim_card_ids": [\n "6b14e151-8493-4fa1-8664-1cc4e6d14158",\n "6b14e151-8493-4fa1-8664-1cc4e6d14158"\n ]\n}' \
--output-document \
- {{baseUrl}}/actions/network_preferences/sim_cards
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["sim_card_ids": ["6b14e151-8493-4fa1-8664-1cc4e6d14158", "6b14e151-8493-4fa1-8664-1cc4e6d14158"]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/actions/network_preferences/sim_cards")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
DELETE network preferences
{{baseUrl}}/sim_cards/:sim_card_id/network_preferences
QUERY PARAMS
sim_card_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
require "http/client"
url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/sim_cards/:sim_card_id/network_preferences HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:sim_card_id/network_preferences',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:sim_card_id/network_preferences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/sim_cards/:sim_card_id/network_preferences")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/sim_cards/:sim_card_id/network_preferences') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/sim_cards/:sim_card_id/network_preferences
http DELETE {{baseUrl}}/sim_cards/:sim_card_id/network_preferences
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/sim_cards/:sim_card_id/network_preferences
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"record_type": "sim_card_network_preferences",
"sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
DELETE
Delete SIM card public IP
{{baseUrl}}/sim_cards/:sim_card_id/public_ip
QUERY PARAMS
sim_card_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:sim_card_id/public_ip");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
require "http/client"
url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:sim_card_id/public_ip"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:sim_card_id/public_ip");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/sim_cards/:sim_card_id/public_ip HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:sim_card_id/public_ip"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:sim_card_id/public_ip';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:sim_card_id/public_ip',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:sim_card_id/public_ip';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:sim_card_id/public_ip"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:sim_card_id/public_ip" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:sim_card_id/public_ip",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:sim_card_id/public_ip' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:sim_card_id/public_ip' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/sim_cards/:sim_card_id/public_ip")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/sim_cards/:sim_card_id/public_ip') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/sim_cards/:sim_card_id/public_ip
http DELETE {{baseUrl}}/sim_cards/:sim_card_id/public_ip
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/sim_cards/:sim_card_id/public_ip
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"ip": "192.168.0.0",
"record_type": "sim_card_public_ip",
"sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
"type": "ipv4",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"ip": "192.168.0.0",
"record_type": "sim_card_public_ip",
"sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
"type": "ipv4",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
DELETE
Deletes a SIM card
{{baseUrl}}/sim_cards/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/sim_cards/:id")
require "http/client"
url = "{{baseUrl}}/sim_cards/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/sim_cards/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/sim_cards/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/sim_cards/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/sim_cards/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/sim_cards/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/sim_cards/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/sim_cards/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/sim_cards/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/sim_cards/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/sim_cards/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/sim_cards/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/sim_cards/:id
http DELETE {{baseUrl}}/sim_cards/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/sim_cards/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"iccid": "89310410106543789301",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"imsi": 81932214823362980,
"ipv4": "192.168.0.0",
"ipv6": "2001:cdba:0000:0000:0000:0000:3257:9652",
"msisdn": "+13109976224",
"record_type": "sim_card",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "enabled",
"tags": [
"personal",
"customers",
"active-customers"
],
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get SIM card public IP definition
{{baseUrl}}/sim_cards/:sim_card_id/public_ip
QUERY PARAMS
sim_card_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:sim_card_id/public_ip");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
require "http/client"
url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:sim_card_id/public_ip"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:sim_card_id/public_ip");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_cards/:sim_card_id/public_ip HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:sim_card_id/public_ip"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:sim_card_id/public_ip';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:sim_card_id/public_ip',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:sim_card_id/public_ip';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:sim_card_id/public_ip"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:sim_card_id/public_ip" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:sim_card_id/public_ip",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:sim_card_id/public_ip' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:sim_card_id/public_ip' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_cards/:sim_card_id/public_ip")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_cards/:sim_card_id/public_ip') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_cards/:sim_card_id/public_ip
http GET {{baseUrl}}/sim_cards/:sim_card_id/public_ip
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_cards/:sim_card_id/public_ip
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"ip": "192.168.0.0",
"record_type": "sim_card_public_ip",
"sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
"type": "ipv4",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get SIM card
{{baseUrl}}/sim_cards/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_cards/:id")
require "http/client"
url = "{{baseUrl}}/sim_cards/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_cards/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_cards/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_cards/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_cards/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sim_cards/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sim_cards/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_cards/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sim_cards/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_cards/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_cards/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_cards/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_cards/:id
http GET {{baseUrl}}/sim_cards/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_cards/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"iccid": "89310410106543789301",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"imsi": 81932214823362980,
"ipv4": "192.168.0.0",
"ipv6": "2001:cdba:0000:0000:0000:0000:3257:9652",
"msisdn": "+13109976224",
"record_type": "sim_card",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "enabled",
"tags": [
"personal",
"customers",
"active-customers"
],
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
Get all SIM cards
{{baseUrl}}/sim_cards
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_cards")
require "http/client"
url = "{{baseUrl}}/sim_cards"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_cards"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_cards HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_cards")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_cards")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_cards');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sim_cards'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/sim_cards'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_cards');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sim_cards'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_cards');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_cards")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_cards') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_cards
http GET {{baseUrl}}/sim_cards
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_cards
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Get network preferences
{{baseUrl}}/sim_cards/:sim_card_id/network_preferences
QUERY PARAMS
sim_card_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
require "http/client"
url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_cards/:sim_card_id/network_preferences HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:sim_card_id/network_preferences',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:sim_card_id/network_preferences",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_cards/:sim_card_id/network_preferences")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_cards/:sim_card_id/network_preferences') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_cards/:sim_card_id/network_preferences
http GET {{baseUrl}}/sim_cards/:sim_card_id/network_preferences
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_cards/:sim_card_id/network_preferences
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"record_type": "sim_card_network_preferences",
"sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
GET
List wireless connectivity logs
{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs
QUERY PARAMS
sim_card_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs")
require "http/client"
url = "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sim_cards/:sim_card_id/wireless_connectivity_logs HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:sim_card_id/wireless_connectivity_logs',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sim_cards/:sim_card_id/wireless_connectivity_logs")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sim_cards/:sim_card_id/wireless_connectivity_logs') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs
http GET {{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:sim_card_id/wireless_connectivity_logs")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Register SIM cards
{{baseUrl}}/actions/register/sim_cards
BODY json
{
"registration_codes": [],
"sim_card_group_id": "",
"status": "",
"tags": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/actions/register/sim_cards");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/actions/register/sim_cards" {:content-type :json
:form-params {:registration_codes ["0000000001" "0000000002" "0000000003"]
:sim_card_group_id "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
:status "standby"
:tags ["personal" "customers" "active-customers"]}})
require "http/client"
url = "{{baseUrl}}/actions/register/sim_cards"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/actions/register/sim_cards"),
Content = new StringContent("{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/actions/register/sim_cards");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/actions/register/sim_cards"
payload := strings.NewReader("{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\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(res)
fmt.Println(string(body))
}
POST /baseUrl/actions/register/sim_cards HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 245
{
"registration_codes": [
"0000000001",
"0000000002",
"0000000003"
],
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": [
"personal",
"customers",
"active-customers"
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/actions/register/sim_cards")
.setHeader("content-type", "application/json")
.setBody("{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/actions/register/sim_cards"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/actions/register/sim_cards")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/actions/register/sim_cards")
.header("content-type", "application/json")
.body("{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}")
.asString();
const data = JSON.stringify({
registration_codes: [
'0000000001',
'0000000002',
'0000000003'
],
sim_card_group_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
status: 'standby',
tags: [
'personal',
'customers',
'active-customers'
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/actions/register/sim_cards');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/register/sim_cards',
headers: {'content-type': 'application/json'},
data: {
registration_codes: ['0000000001', '0000000002', '0000000003'],
sim_card_group_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
status: 'standby',
tags: ['personal', 'customers', 'active-customers']
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/actions/register/sim_cards';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"registration_codes":["0000000001","0000000002","0000000003"],"sim_card_group_id":"6a09cdc3-8948-47f0-aa62-74ac943d6c58","status":"standby","tags":["personal","customers","active-customers"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/actions/register/sim_cards',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "registration_codes": [\n "0000000001",\n "0000000002",\n "0000000003"\n ],\n "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",\n "status": "standby",\n "tags": [\n "personal",\n "customers",\n "active-customers"\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/actions/register/sim_cards")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/actions/register/sim_cards',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
registration_codes: ['0000000001', '0000000002', '0000000003'],
sim_card_group_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
status: 'standby',
tags: ['personal', 'customers', 'active-customers']
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/register/sim_cards',
headers: {'content-type': 'application/json'},
body: {
registration_codes: ['0000000001', '0000000002', '0000000003'],
sim_card_group_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
status: 'standby',
tags: ['personal', 'customers', 'active-customers']
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/actions/register/sim_cards');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
registration_codes: [
'0000000001',
'0000000002',
'0000000003'
],
sim_card_group_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
status: 'standby',
tags: [
'personal',
'customers',
'active-customers'
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/actions/register/sim_cards',
headers: {'content-type': 'application/json'},
data: {
registration_codes: ['0000000001', '0000000002', '0000000003'],
sim_card_group_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
status: 'standby',
tags: ['personal', 'customers', 'active-customers']
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/actions/register/sim_cards';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"registration_codes":["0000000001","0000000002","0000000003"],"sim_card_group_id":"6a09cdc3-8948-47f0-aa62-74ac943d6c58","status":"standby","tags":["personal","customers","active-customers"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"registration_codes": @[ @"0000000001", @"0000000002", @"0000000003" ],
@"sim_card_group_id": @"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
@"status": @"standby",
@"tags": @[ @"personal", @"customers", @"active-customers" ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/actions/register/sim_cards"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/actions/register/sim_cards" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/actions/register/sim_cards",
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([
'registration_codes' => [
'0000000001',
'0000000002',
'0000000003'
],
'sim_card_group_id' => '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
'status' => 'standby',
'tags' => [
'personal',
'customers',
'active-customers'
]
]),
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;
}
request('POST', '{{baseUrl}}/actions/register/sim_cards', [
'body' => '{
"registration_codes": [
"0000000001",
"0000000002",
"0000000003"
],
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": [
"personal",
"customers",
"active-customers"
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/actions/register/sim_cards');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'registration_codes' => [
'0000000001',
'0000000002',
'0000000003'
],
'sim_card_group_id' => '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
'status' => 'standby',
'tags' => [
'personal',
'customers',
'active-customers'
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'registration_codes' => [
'0000000001',
'0000000002',
'0000000003'
],
'sim_card_group_id' => '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
'status' => 'standby',
'tags' => [
'personal',
'customers',
'active-customers'
]
]));
$request->setRequestUrl('{{baseUrl}}/actions/register/sim_cards');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/actions/register/sim_cards' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"registration_codes": [
"0000000001",
"0000000002",
"0000000003"
],
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": [
"personal",
"customers",
"active-customers"
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/actions/register/sim_cards' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"registration_codes": [
"0000000001",
"0000000002",
"0000000003"
],
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": [
"personal",
"customers",
"active-customers"
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/actions/register/sim_cards", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/actions/register/sim_cards"
payload = {
"registration_codes": ["0000000001", "0000000002", "0000000003"],
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": ["personal", "customers", "active-customers"]
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/actions/register/sim_cards"
payload <- "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/actions/register/sim_cards")
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 \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/actions/register/sim_cards') do |req|
req.body = "{\n \"registration_codes\": [\n \"0000000001\",\n \"0000000002\",\n \"0000000003\"\n ],\n \"sim_card_group_id\": \"6a09cdc3-8948-47f0-aa62-74ac943d6c58\",\n \"status\": \"standby\",\n \"tags\": [\n \"personal\",\n \"customers\",\n \"active-customers\"\n ]\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/actions/register/sim_cards";
let payload = json!({
"registration_codes": ("0000000001", "0000000002", "0000000003"),
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": ("personal", "customers", "active-customers")
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/actions/register/sim_cards \
--header 'content-type: application/json' \
--data '{
"registration_codes": [
"0000000001",
"0000000002",
"0000000003"
],
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": [
"personal",
"customers",
"active-customers"
]
}'
echo '{
"registration_codes": [
"0000000001",
"0000000002",
"0000000003"
],
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": [
"personal",
"customers",
"active-customers"
]
}' | \
http POST {{baseUrl}}/actions/register/sim_cards \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "registration_codes": [\n "0000000001",\n "0000000002",\n "0000000003"\n ],\n "sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",\n "status": "standby",\n "tags": [\n "personal",\n "customers",\n "active-customers"\n ]\n}' \
--output-document \
- {{baseUrl}}/actions/register/sim_cards
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"registration_codes": ["0000000001", "0000000002", "0000000003"],
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "standby",
"tags": ["personal", "customers", "active-customers"]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/actions/register/sim_cards")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Request a SIM card disable
{{baseUrl}}/sim_cards/:id/actions/disable
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:id/actions/disable");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_cards/:id/actions/disable")
require "http/client"
url = "{{baseUrl}}/sim_cards/:id/actions/disable"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:id/actions/disable"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:id/actions/disable");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:id/actions/disable"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_cards/:id/actions/disable HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_cards/:id/actions/disable")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:id/actions/disable"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:id/actions/disable")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_cards/:id/actions/disable")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_cards/:id/actions/disable');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/disable'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:id/actions/disable';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:id/actions/disable',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:id/actions/disable")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:id/actions/disable',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/disable'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_cards/:id/actions/disable');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/disable'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:id/actions/disable';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:id/actions/disable"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:id/actions/disable" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:id/actions/disable",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/sim_cards/:id/actions/disable');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:id/actions/disable');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:id/actions/disable');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:id/actions/disable' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:id/actions/disable' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/sim_cards/:id/actions/disable")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:id/actions/disable"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:id/actions/disable"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:id/actions/disable")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/sim_cards/:id/actions/disable') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:id/actions/disable";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_cards/:id/actions/disable
http POST {{baseUrl}}/sim_cards/:id/actions/disable
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/sim_cards/:id/actions/disable
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:id/actions/disable")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"iccid": "89310410106543789301",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"imsi": 81932214823362980,
"msisdn": "+13109976224",
"record_type": "sim_card",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "enabled",
"tags": [
"personal",
"customers",
"active-customers"
],
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Request a SIM card enable
{{baseUrl}}/sim_cards/:id/actions/enable
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:id/actions/enable");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_cards/:id/actions/enable")
require "http/client"
url = "{{baseUrl}}/sim_cards/:id/actions/enable"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:id/actions/enable"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:id/actions/enable");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:id/actions/enable"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_cards/:id/actions/enable HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_cards/:id/actions/enable")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:id/actions/enable"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:id/actions/enable")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_cards/:id/actions/enable")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_cards/:id/actions/enable');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/enable'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:id/actions/enable';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:id/actions/enable',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:id/actions/enable")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:id/actions/enable',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/enable'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_cards/:id/actions/enable');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/enable'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:id/actions/enable';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:id/actions/enable"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:id/actions/enable" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:id/actions/enable",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/sim_cards/:id/actions/enable');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:id/actions/enable');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:id/actions/enable');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:id/actions/enable' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:id/actions/enable' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/sim_cards/:id/actions/enable")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:id/actions/enable"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:id/actions/enable"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:id/actions/enable")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/sim_cards/:id/actions/enable') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:id/actions/enable";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_cards/:id/actions/enable
http POST {{baseUrl}}/sim_cards/:id/actions/enable
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/sim_cards/:id/actions/enable
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:id/actions/enable")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"iccid": "89310410106543789301",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"imsi": 81932214823362980,
"msisdn": "+13109976224",
"record_type": "sim_card",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "enabled",
"tags": [
"personal",
"customers",
"active-customers"
],
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Request setting a SIM card to standby
{{baseUrl}}/sim_cards/:id/actions/set_standby
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:id/actions/set_standby");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_cards/:id/actions/set_standby")
require "http/client"
url = "{{baseUrl}}/sim_cards/:id/actions/set_standby"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:id/actions/set_standby"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:id/actions/set_standby");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:id/actions/set_standby"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_cards/:id/actions/set_standby HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_cards/:id/actions/set_standby")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:id/actions/set_standby"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:id/actions/set_standby")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_cards/:id/actions/set_standby")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_cards/:id/actions/set_standby');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/set_standby'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:id/actions/set_standby';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:id/actions/set_standby',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:id/actions/set_standby")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:id/actions/set_standby',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/set_standby'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_cards/:id/actions/set_standby');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:id/actions/set_standby'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:id/actions/set_standby';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:id/actions/set_standby"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:id/actions/set_standby" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:id/actions/set_standby",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/sim_cards/:id/actions/set_standby');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:id/actions/set_standby');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:id/actions/set_standby');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:id/actions/set_standby' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:id/actions/set_standby' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/sim_cards/:id/actions/set_standby")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:id/actions/set_standby"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:id/actions/set_standby"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:id/actions/set_standby")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/sim_cards/:id/actions/set_standby') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:id/actions/set_standby";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_cards/:id/actions/set_standby
http POST {{baseUrl}}/sim_cards/:id/actions/set_standby
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/sim_cards/:id/actions/set_standby
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:id/actions/set_standby")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"iccid": "89310410106543789301",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"imsi": 81932214823362980,
"msisdn": "+13109976224",
"record_type": "sim_card",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "enabled",
"tags": [
"personal",
"customers",
"active-customers"
],
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Set SIM card public IP
{{baseUrl}}/sim_cards/:sim_card_id/public_ip
QUERY PARAMS
sim_card_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:sim_card_id/public_ip");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
require "http/client"
url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:sim_card_id/public_ip"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:sim_card_id/public_ip");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_cards/:sim_card_id/public_ip HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:sim_card_id/public_ip"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:sim_card_id/public_ip';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:sim_card_id/public_ip',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/:sim_card_id/public_ip'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:sim_card_id/public_ip';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:sim_card_id/public_ip"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:sim_card_id/public_ip" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:sim_card_id/public_ip",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sim_cards/:sim_card_id/public_ip');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:sim_card_id/public_ip' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:sim_card_id/public_ip' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/sim_cards/:sim_card_id/public_ip")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:sim_card_id/public_ip"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:sim_card_id/public_ip")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/sim_cards/:sim_card_id/public_ip') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:sim_card_id/public_ip";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_cards/:sim_card_id/public_ip
http POST {{baseUrl}}/sim_cards/:sim_card_id/public_ip
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/sim_cards/:sim_card_id/public_ip
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:sim_card_id/public_ip")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"ip": "192.168.0.0",
"record_type": "sim_card_public_ip",
"sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
"type": "ipv4",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
PUT
Set network preferences
{{baseUrl}}/sim_cards/:sim_card_id/network_preferences
QUERY PARAMS
sim_card_id
BODY json
{
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
]
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences" {:content-type :json
:form-params {:mobile_operator_networks_preferences [{:mobile_operator_network_id ""
:priority 0}]}})
require "http/client"
url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"),
Content = new StringContent("{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
payload := strings.NewReader("{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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(res)
fmt.Println(string(body))
}
PUT /baseUrl/sim_cards/:sim_card_id/network_preferences HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 123
{
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.setHeader("content-type", "application/json")
.setBody("{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.header("content-type", "application/json")
.body("{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}")
.asString();
const data = JSON.stringify({
mobile_operator_networks_preferences: [
{
mobile_operator_network_id: '',
priority: 0
}
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences',
headers: {'content-type': 'application/json'},
data: {
mobile_operator_networks_preferences: [{mobile_operator_network_id: '', priority: 0}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"mobile_operator_networks_preferences":[{"mobile_operator_network_id":"","priority":0}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "mobile_operator_networks_preferences": [\n {\n "mobile_operator_network_id": "",\n "priority": 0\n }\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:sim_card_id/network_preferences',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
mobile_operator_networks_preferences: [{mobile_operator_network_id: '', priority: 0}]
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences',
headers: {'content-type': 'application/json'},
body: {
mobile_operator_networks_preferences: [{mobile_operator_network_id: '', priority: 0}]
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
mobile_operator_networks_preferences: [
{
mobile_operator_network_id: '',
priority: 0
}
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences',
headers: {'content-type': 'application/json'},
data: {
mobile_operator_networks_preferences: [{mobile_operator_network_id: '', priority: 0}]
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"mobile_operator_networks_preferences":[{"mobile_operator_network_id":"","priority":0}]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"mobile_operator_networks_preferences": @[ @{ @"mobile_operator_network_id": @"", @"priority": @0 } ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:sim_card_id/network_preferences",
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([
'mobile_operator_networks_preferences' => [
[
'mobile_operator_network_id' => '',
'priority' => 0
]
]
]),
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;
}
request('PUT', '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences', [
'body' => '{
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'mobile_operator_networks_preferences' => [
[
'mobile_operator_network_id' => '',
'priority' => 0
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'mobile_operator_networks_preferences' => [
[
'mobile_operator_network_id' => '',
'priority' => 0
]
]
]));
$request->setRequestUrl('{{baseUrl}}/sim_cards/:sim_card_id/network_preferences');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:sim_card_id/network_preferences' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/sim_cards/:sim_card_id/network_preferences", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
payload = { "mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
] }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences"
payload <- "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/sim_cards/:sim_card_id/network_preferences') do |req|
req.body = "{\n \"mobile_operator_networks_preferences\": [\n {\n \"mobile_operator_network_id\": \"\",\n \"priority\": 0\n }\n ]\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences";
let payload = json!({"mobile_operator_networks_preferences": (
json!({
"mobile_operator_network_id": "",
"priority": 0
})
)});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/sim_cards/:sim_card_id/network_preferences \
--header 'content-type: application/json' \
--data '{
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
]
}'
echo '{
"mobile_operator_networks_preferences": [
{
"mobile_operator_network_id": "",
"priority": 0
}
]
}' | \
http PUT {{baseUrl}}/sim_cards/:sim_card_id/network_preferences \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "mobile_operator_networks_preferences": [\n {\n "mobile_operator_network_id": "",\n "priority": 0\n }\n ]\n}' \
--output-document \
- {{baseUrl}}/sim_cards/:sim_card_id/network_preferences
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["mobile_operator_networks_preferences": [
[
"mobile_operator_network_id": "",
"priority": 0
]
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:sim_card_id/network_preferences")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"record_type": "sim_card_network_preferences",
"sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
PATCH
Update a SIM card
{{baseUrl}}/sim_cards/:id
QUERY PARAMS
id
BODY json
{
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/sim_cards/:id" {:content-type :json
:form-params {:created_at ""
:iccid ""
:id ""
:imsi ""
:ipv4 ""
:ipv6 ""
:msisdn ""
:record_type ""
:sim_card_group_id ""
:status ""
:tags []
:updated_at ""}})
require "http/client"
url = "{{baseUrl}}/sim_cards/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/sim_cards/:id"),
Content = new StringContent("{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/:id"
payload := strings.NewReader("{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/sim_cards/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 205
{
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/sim_cards/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/sim_cards/:id")
.header("content-type", "application/json")
.body("{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}")
.asString();
const data = JSON.stringify({
created_at: '',
iccid: '',
id: '',
imsi: '',
ipv4: '',
ipv6: '',
msisdn: '',
record_type: '',
sim_card_group_id: '',
status: '',
tags: [],
updated_at: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/sim_cards/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sim_cards/:id',
headers: {'content-type': 'application/json'},
data: {
created_at: '',
iccid: '',
id: '',
imsi: '',
ipv4: '',
ipv6: '',
msisdn: '',
record_type: '',
sim_card_group_id: '',
status: '',
tags: [],
updated_at: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"created_at":"","iccid":"","id":"","imsi":"","ipv4":"","ipv6":"","msisdn":"","record_type":"","sim_card_group_id":"","status":"","tags":[],"updated_at":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "created_at": "",\n "iccid": "",\n "id": "",\n "imsi": "",\n "ipv4": "",\n "ipv6": "",\n "msisdn": "",\n "record_type": "",\n "sim_card_group_id": "",\n "status": "",\n "tags": [],\n "updated_at": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
created_at: '',
iccid: '',
id: '',
imsi: '',
ipv4: '',
ipv6: '',
msisdn: '',
record_type: '',
sim_card_group_id: '',
status: '',
tags: [],
updated_at: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sim_cards/:id',
headers: {'content-type': 'application/json'},
body: {
created_at: '',
iccid: '',
id: '',
imsi: '',
ipv4: '',
ipv6: '',
msisdn: '',
record_type: '',
sim_card_group_id: '',
status: '',
tags: [],
updated_at: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/sim_cards/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
created_at: '',
iccid: '',
id: '',
imsi: '',
ipv4: '',
ipv6: '',
msisdn: '',
record_type: '',
sim_card_group_id: '',
status: '',
tags: [],
updated_at: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/sim_cards/:id',
headers: {'content-type': 'application/json'},
data: {
created_at: '',
iccid: '',
id: '',
imsi: '',
ipv4: '',
ipv6: '',
msisdn: '',
record_type: '',
sim_card_group_id: '',
status: '',
tags: [],
updated_at: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"created_at":"","iccid":"","id":"","imsi":"","ipv4":"","ipv6":"","msisdn":"","record_type":"","sim_card_group_id":"","status":"","tags":[],"updated_at":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"created_at": @"",
@"iccid": @"",
@"id": @"",
@"imsi": @"",
@"ipv4": @"",
@"ipv6": @"",
@"msisdn": @"",
@"record_type": @"",
@"sim_card_group_id": @"",
@"status": @"",
@"tags": @[ ],
@"updated_at": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/:id",
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([
'created_at' => '',
'iccid' => '',
'id' => '',
'imsi' => '',
'ipv4' => '',
'ipv6' => '',
'msisdn' => '',
'record_type' => '',
'sim_card_group_id' => '',
'status' => '',
'tags' => [
],
'updated_at' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/sim_cards/:id', [
'body' => '{
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'created_at' => '',
'iccid' => '',
'id' => '',
'imsi' => '',
'ipv4' => '',
'ipv6' => '',
'msisdn' => '',
'record_type' => '',
'sim_card_group_id' => '',
'status' => '',
'tags' => [
],
'updated_at' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'created_at' => '',
'iccid' => '',
'id' => '',
'imsi' => '',
'ipv4' => '',
'ipv6' => '',
'msisdn' => '',
'record_type' => '',
'sim_card_group_id' => '',
'status' => '',
'tags' => [
],
'updated_at' => ''
]));
$request->setRequestUrl('{{baseUrl}}/sim_cards/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/sim_cards/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/:id"
payload = {
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/:id"
payload <- "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/sim_cards/:id') do |req|
req.body = "{\n \"created_at\": \"\",\n \"iccid\": \"\",\n \"id\": \"\",\n \"imsi\": \"\",\n \"ipv4\": \"\",\n \"ipv6\": \"\",\n \"msisdn\": \"\",\n \"record_type\": \"\",\n \"sim_card_group_id\": \"\",\n \"status\": \"\",\n \"tags\": [],\n \"updated_at\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/:id";
let payload = json!({
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": (),
"updated_at": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/sim_cards/:id \
--header 'content-type: application/json' \
--data '{
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
}'
echo '{
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
}' | \
http PATCH {{baseUrl}}/sim_cards/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "created_at": "",\n "iccid": "",\n "id": "",\n "imsi": "",\n "ipv4": "",\n "ipv6": "",\n "msisdn": "",\n "record_type": "",\n "sim_card_group_id": "",\n "status": "",\n "tags": [],\n "updated_at": ""\n}' \
--output-document \
- {{baseUrl}}/sim_cards/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"created_at": "",
"iccid": "",
"id": "",
"imsi": "",
"ipv4": "",
"ipv6": "",
"msisdn": "",
"record_type": "",
"sim_card_group_id": "",
"status": "",
"tags": [],
"updated_at": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2018-02-02T22:25:27.521Z",
"iccid": "89310410106543789301",
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"imsi": 81932214823362980,
"ipv4": "192.168.0.0",
"ipv6": "2001:cdba:0000:0000:0000:0000:3257:9652",
"msisdn": "+13109976224",
"record_type": "sim_card",
"sim_card_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"status": "enabled",
"tags": [
"personal",
"customers",
"active-customers"
],
"updated_at": "2018-02-02T22:25:27.521Z"
}
}
POST
Validate SIM cards registration codes
{{baseUrl}}/sim_cards/actions/validate_registration_codes
BODY json
{
"registration_codes": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sim_cards/actions/validate_registration_codes");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sim_cards/actions/validate_registration_codes" {:content-type :json
:form-params {:registration_codes ["123456780" "1231231230"]}})
require "http/client"
url = "{{baseUrl}}/sim_cards/actions/validate_registration_codes"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sim_cards/actions/validate_registration_codes"),
Content = new StringContent("{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sim_cards/actions/validate_registration_codes");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sim_cards/actions/validate_registration_codes"
payload := strings.NewReader("{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\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(res)
fmt.Println(string(body))
}
POST /baseUrl/sim_cards/actions/validate_registration_codes HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 67
{
"registration_codes": [
"123456780",
"1231231230"
]
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sim_cards/actions/validate_registration_codes")
.setHeader("content-type", "application/json")
.setBody("{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sim_cards/actions/validate_registration_codes"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/sim_cards/actions/validate_registration_codes")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sim_cards/actions/validate_registration_codes")
.header("content-type", "application/json")
.body("{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}")
.asString();
const data = JSON.stringify({
registration_codes: [
'123456780',
'1231231230'
]
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/sim_cards/actions/validate_registration_codes');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/actions/validate_registration_codes',
headers: {'content-type': 'application/json'},
data: {registration_codes: ['123456780', '1231231230']}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sim_cards/actions/validate_registration_codes';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"registration_codes":["123456780","1231231230"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/sim_cards/actions/validate_registration_codes',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "registration_codes": [\n "123456780",\n "1231231230"\n ]\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}")
val request = Request.Builder()
.url("{{baseUrl}}/sim_cards/actions/validate_registration_codes")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sim_cards/actions/validate_registration_codes',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({registration_codes: ['123456780', '1231231230']}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/actions/validate_registration_codes',
headers: {'content-type': 'application/json'},
body: {registration_codes: ['123456780', '1231231230']},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sim_cards/actions/validate_registration_codes');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
registration_codes: [
'123456780',
'1231231230'
]
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/sim_cards/actions/validate_registration_codes',
headers: {'content-type': 'application/json'},
data: {registration_codes: ['123456780', '1231231230']}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sim_cards/actions/validate_registration_codes';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"registration_codes":["123456780","1231231230"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"registration_codes": @[ @"123456780", @"1231231230" ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sim_cards/actions/validate_registration_codes"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/sim_cards/actions/validate_registration_codes" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sim_cards/actions/validate_registration_codes",
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([
'registration_codes' => [
'123456780',
'1231231230'
]
]),
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;
}
request('POST', '{{baseUrl}}/sim_cards/actions/validate_registration_codes', [
'body' => '{
"registration_codes": [
"123456780",
"1231231230"
]
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sim_cards/actions/validate_registration_codes');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'registration_codes' => [
'123456780',
'1231231230'
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'registration_codes' => [
'123456780',
'1231231230'
]
]));
$request->setRequestUrl('{{baseUrl}}/sim_cards/actions/validate_registration_codes');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sim_cards/actions/validate_registration_codes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"registration_codes": [
"123456780",
"1231231230"
]
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sim_cards/actions/validate_registration_codes' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"registration_codes": [
"123456780",
"1231231230"
]
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/sim_cards/actions/validate_registration_codes", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sim_cards/actions/validate_registration_codes"
payload = { "registration_codes": ["123456780", "1231231230"] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sim_cards/actions/validate_registration_codes"
payload <- "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sim_cards/actions/validate_registration_codes")
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 \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/sim_cards/actions/validate_registration_codes') do |req|
req.body = "{\n \"registration_codes\": [\n \"123456780\",\n \"1231231230\"\n ]\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sim_cards/actions/validate_registration_codes";
let payload = json!({"registration_codes": ("123456780", "1231231230")});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/sim_cards/actions/validate_registration_codes \
--header 'content-type: application/json' \
--data '{
"registration_codes": [
"123456780",
"1231231230"
]
}'
echo '{
"registration_codes": [
"123456780",
"1231231230"
]
}' | \
http POST {{baseUrl}}/sim_cards/actions/validate_registration_codes \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "registration_codes": [\n "123456780",\n "1231231230"\n ]\n}' \
--output-document \
- {{baseUrl}}/sim_cards/actions/validate_registration_codes
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["registration_codes": ["123456780", "1231231230"]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sim_cards/actions/validate_registration_codes")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Creates a TeXML Application
{{baseUrl}}/texml_applications
BODY json
{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/texml_applications");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/texml_applications" {:content-type :json
:form-params {:active false
:anchorsite_override ""
:dtmf_type ""
:first_command_timeout false
:first_command_timeout_secs 0
:friendly_name ""
:inbound {:channel_limit 0
:sip_subdomain ""
:sip_subdomain_receive_settings ""}
:outbound {:channel_limit 0
:outbound_voice_profile_id ""}
:status_callback ""
:status_callback_method ""
:voice_fallback_url ""
:voice_method ""
:voice_url ""}})
require "http/client"
url = "{{baseUrl}}/texml_applications"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/texml_applications"),
Content = new StringContent("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/texml_applications");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/texml_applications"
payload := strings.NewReader("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/texml_applications HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 478
{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/texml_applications")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/texml_applications"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/texml_applications")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/texml_applications")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
.asString();
const data = JSON.stringify({
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/texml_applications');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/texml_applications',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/texml_applications';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","dtmf_type":"","first_command_timeout":false,"first_command_timeout_secs":0,"friendly_name":"","inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"status_callback":"","status_callback_method":"","voice_fallback_url":"","voice_method":"","voice_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/texml_applications',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "anchorsite_override": "",\n "dtmf_type": "",\n "first_command_timeout": false,\n "first_command_timeout_secs": 0,\n "friendly_name": "",\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "status_callback": "",\n "status_callback_method": "",\n "voice_fallback_url": "",\n "voice_method": "",\n "voice_url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/texml_applications")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/texml_applications',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/texml_applications',
headers: {'content-type': 'application/json'},
body: {
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/texml_applications');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/texml_applications',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/texml_applications';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","dtmf_type":"","first_command_timeout":false,"first_command_timeout_secs":0,"friendly_name":"","inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"status_callback":"","status_callback_method":"","voice_fallback_url":"","voice_method":"","voice_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"anchorsite_override": @"",
@"dtmf_type": @"",
@"first_command_timeout": @NO,
@"first_command_timeout_secs": @0,
@"friendly_name": @"",
@"inbound": @{ @"channel_limit": @0, @"sip_subdomain": @"", @"sip_subdomain_receive_settings": @"" },
@"outbound": @{ @"channel_limit": @0, @"outbound_voice_profile_id": @"" },
@"status_callback": @"",
@"status_callback_method": @"",
@"voice_fallback_url": @"",
@"voice_method": @"",
@"voice_url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/texml_applications"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/texml_applications" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/texml_applications",
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([
'active' => null,
'anchorsite_override' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'friendly_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'status_callback' => '',
'status_callback_method' => '',
'voice_fallback_url' => '',
'voice_method' => '',
'voice_url' => ''
]),
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;
}
request('POST', '{{baseUrl}}/texml_applications', [
'body' => '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/texml_applications');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'anchorsite_override' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'friendly_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'status_callback' => '',
'status_callback_method' => '',
'voice_fallback_url' => '',
'voice_method' => '',
'voice_url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'anchorsite_override' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'friendly_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'status_callback' => '',
'status_callback_method' => '',
'voice_fallback_url' => '',
'voice_method' => '',
'voice_url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/texml_applications');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/texml_applications' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/texml_applications' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/texml_applications", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/texml_applications"
payload = {
"active": False,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": False,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/texml_applications"
payload <- "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/texml_applications")
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 \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/texml_applications') do |req|
req.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/texml_applications";
let payload = json!({
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": json!({
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
}),
"outbound": json!({
"channel_limit": 0,
"outbound_voice_profile_id": ""
}),
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/texml_applications \
--header 'content-type: application/json' \
--data '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}'
echo '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}' | \
http POST {{baseUrl}}/texml_applications \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "anchorsite_override": "",\n "dtmf_type": "",\n "first_command_timeout": false,\n "first_command_timeout_secs": 0,\n "friendly_name": "",\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "status_callback": "",\n "status_callback_method": "",\n "voice_fallback_url": "",\n "voice_method": "",\n "voice_url": ""\n}' \
--output-document \
- {{baseUrl}}/texml_applications
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": [
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
],
"outbound": [
"channel_limit": 0,
"outbound_voice_profile_id": ""
],
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/texml_applications")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"created_at": "2020-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"friendly_name": "call-router",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "texml_application",
"status_callback": "https://example.com",
"status_callback_method": "get",
"updated_at": "2020-02-03T22:25:27.521Z",
"voice_fallback_url": "https://fallback.example.com",
"voice_method": "get",
"voice_url": "https://example.com"
}
}
DELETE
Deletes a TeXML Application
{{baseUrl}}/texml_applications/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/texml_applications/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/texml_applications/:id")
require "http/client"
url = "{{baseUrl}}/texml_applications/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/texml_applications/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/texml_applications/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/texml_applications/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/texml_applications/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/texml_applications/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/texml_applications/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/texml_applications/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/texml_applications/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/texml_applications/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/texml_applications/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/texml_applications/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/texml_applications/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/texml_applications/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/texml_applications/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'DELETE', url: '{{baseUrl}}/texml_applications/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/texml_applications/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'DELETE', url: '{{baseUrl}}/texml_applications/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/texml_applications/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/texml_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/texml_applications/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/texml_applications/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/texml_applications/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/texml_applications/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/texml_applications/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/texml_applications/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/texml_applications/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/texml_applications/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/texml_applications/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/texml_applications/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/texml_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/texml_applications/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/texml_applications/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/texml_applications/:id
http DELETE {{baseUrl}}/texml_applications/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/texml_applications/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/texml_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"created_at": "2020-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"friendly_name": "call-router",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "texml_application",
"status_callback": "https://example.com",
"status_callback_method": "get",
"updated_at": "2020-02-03T22:25:27.521Z",
"voice_fallback_url": "https://fallback.example.com",
"voice_method": "get",
"voice_url": "https://example.com"
}
}
GET
List all TeXML Applications
{{baseUrl}}/texml_applications
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/texml_applications");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/texml_applications")
require "http/client"
url = "{{baseUrl}}/texml_applications"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/texml_applications"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/texml_applications");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/texml_applications"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/texml_applications HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/texml_applications")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/texml_applications"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/texml_applications")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/texml_applications")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/texml_applications');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/texml_applications'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/texml_applications';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/texml_applications',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/texml_applications")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/texml_applications',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/texml_applications'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/texml_applications');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/texml_applications'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/texml_applications';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/texml_applications"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/texml_applications" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/texml_applications",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/texml_applications');
echo $response->getBody();
setUrl('{{baseUrl}}/texml_applications');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/texml_applications');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/texml_applications' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/texml_applications' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/texml_applications")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/texml_applications"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/texml_applications"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/texml_applications")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/texml_applications') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/texml_applications";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/texml_applications
http GET {{baseUrl}}/texml_applications
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/texml_applications
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/texml_applications")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"created_at": "2020-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"friendly_name": "call-router",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "texml_application",
"status_callback": "https://example.com",
"status_callback_method": "get",
"updated_at": "2020-02-03T22:25:27.521Z",
"voice_fallback_url": "https://fallback.example.com",
"voice_method": "get",
"voice_url": "https://example.com"
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a TeXML Application
{{baseUrl}}/texml_applications/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/texml_applications/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/texml_applications/:id")
require "http/client"
url = "{{baseUrl}}/texml_applications/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/texml_applications/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/texml_applications/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/texml_applications/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/texml_applications/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/texml_applications/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/texml_applications/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/texml_applications/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/texml_applications/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/texml_applications/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/texml_applications/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/texml_applications/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/texml_applications/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/texml_applications/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/texml_applications/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/texml_applications/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/texml_applications/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/texml_applications/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/texml_applications/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/texml_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/texml_applications/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/texml_applications/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/texml_applications/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/texml_applications/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/texml_applications/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/texml_applications/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/texml_applications/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/texml_applications/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/texml_applications/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/texml_applications/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/texml_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/texml_applications/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/texml_applications/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/texml_applications/:id
http GET {{baseUrl}}/texml_applications/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/texml_applications/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/texml_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"created_at": "2020-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"friendly_name": "call-router",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "texml_application",
"status_callback": "https://example.com",
"status_callback_method": "get",
"updated_at": "2020-02-03T22:25:27.521Z",
"voice_fallback_url": "https://fallback.example.com",
"voice_method": "get",
"voice_url": "https://example.com"
}
}
PATCH
Update a TeXML Application
{{baseUrl}}/texml_applications/:id
QUERY PARAMS
id
BODY json
{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/texml_applications/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/texml_applications/:id" {:content-type :json
:form-params {:active false
:anchorsite_override ""
:dtmf_type ""
:first_command_timeout false
:first_command_timeout_secs 0
:friendly_name ""
:inbound {:channel_limit 0
:sip_subdomain ""
:sip_subdomain_receive_settings ""}
:outbound {:channel_limit 0
:outbound_voice_profile_id ""}
:status_callback ""
:status_callback_method ""
:voice_fallback_url ""
:voice_method ""
:voice_url ""}})
require "http/client"
url = "{{baseUrl}}/texml_applications/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/texml_applications/:id"),
Content = new StringContent("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/texml_applications/:id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/texml_applications/:id"
payload := strings.NewReader("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/texml_applications/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 478
{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/texml_applications/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/texml_applications/:id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/texml_applications/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/texml_applications/:id")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
.asString();
const data = JSON.stringify({
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/texml_applications/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/texml_applications/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/texml_applications/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","dtmf_type":"","first_command_timeout":false,"first_command_timeout_secs":0,"friendly_name":"","inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"status_callback":"","status_callback_method":"","voice_fallback_url":"","voice_method":"","voice_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/texml_applications/:id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "anchorsite_override": "",\n "dtmf_type": "",\n "first_command_timeout": false,\n "first_command_timeout_secs": 0,\n "friendly_name": "",\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "status_callback": "",\n "status_callback_method": "",\n "voice_fallback_url": "",\n "voice_method": "",\n "voice_url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/texml_applications/:id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/texml_applications/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/texml_applications/:id',
headers: {'content-type': 'application/json'},
body: {
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/texml_applications/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {
channel_limit: 0,
sip_subdomain: '',
sip_subdomain_receive_settings: ''
},
outbound: {
channel_limit: 0,
outbound_voice_profile_id: ''
},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/texml_applications/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
anchorsite_override: '',
dtmf_type: '',
first_command_timeout: false,
first_command_timeout_secs: 0,
friendly_name: '',
inbound: {channel_limit: 0, sip_subdomain: '', sip_subdomain_receive_settings: ''},
outbound: {channel_limit: 0, outbound_voice_profile_id: ''},
status_callback: '',
status_callback_method: '',
voice_fallback_url: '',
voice_method: '',
voice_url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/texml_applications/:id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"active":false,"anchorsite_override":"","dtmf_type":"","first_command_timeout":false,"first_command_timeout_secs":0,"friendly_name":"","inbound":{"channel_limit":0,"sip_subdomain":"","sip_subdomain_receive_settings":""},"outbound":{"channel_limit":0,"outbound_voice_profile_id":""},"status_callback":"","status_callback_method":"","voice_fallback_url":"","voice_method":"","voice_url":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"active": @NO,
@"anchorsite_override": @"",
@"dtmf_type": @"",
@"first_command_timeout": @NO,
@"first_command_timeout_secs": @0,
@"friendly_name": @"",
@"inbound": @{ @"channel_limit": @0, @"sip_subdomain": @"", @"sip_subdomain_receive_settings": @"" },
@"outbound": @{ @"channel_limit": @0, @"outbound_voice_profile_id": @"" },
@"status_callback": @"",
@"status_callback_method": @"",
@"voice_fallback_url": @"",
@"voice_method": @"",
@"voice_url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/texml_applications/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/texml_applications/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/texml_applications/:id",
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([
'active' => null,
'anchorsite_override' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'friendly_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'status_callback' => '',
'status_callback_method' => '',
'voice_fallback_url' => '',
'voice_method' => '',
'voice_url' => ''
]),
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;
}
request('PATCH', '{{baseUrl}}/texml_applications/:id', [
'body' => '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/texml_applications/:id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'anchorsite_override' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'friendly_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'status_callback' => '',
'status_callback_method' => '',
'voice_fallback_url' => '',
'voice_method' => '',
'voice_url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'active' => null,
'anchorsite_override' => '',
'dtmf_type' => '',
'first_command_timeout' => null,
'first_command_timeout_secs' => 0,
'friendly_name' => '',
'inbound' => [
'channel_limit' => 0,
'sip_subdomain' => '',
'sip_subdomain_receive_settings' => ''
],
'outbound' => [
'channel_limit' => 0,
'outbound_voice_profile_id' => ''
],
'status_callback' => '',
'status_callback_method' => '',
'voice_fallback_url' => '',
'voice_method' => '',
'voice_url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/texml_applications/:id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/texml_applications/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/texml_applications/:id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/texml_applications/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/texml_applications/:id"
payload = {
"active": False,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": False,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/texml_applications/:id"
payload <- "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/texml_applications/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/texml_applications/:id') do |req|
req.body = "{\n \"active\": false,\n \"anchorsite_override\": \"\",\n \"dtmf_type\": \"\",\n \"first_command_timeout\": false,\n \"first_command_timeout_secs\": 0,\n \"friendly_name\": \"\",\n \"inbound\": {\n \"channel_limit\": 0,\n \"sip_subdomain\": \"\",\n \"sip_subdomain_receive_settings\": \"\"\n },\n \"outbound\": {\n \"channel_limit\": 0,\n \"outbound_voice_profile_id\": \"\"\n },\n \"status_callback\": \"\",\n \"status_callback_method\": \"\",\n \"voice_fallback_url\": \"\",\n \"voice_method\": \"\",\n \"voice_url\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/texml_applications/:id";
let payload = json!({
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": json!({
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
}),
"outbound": json!({
"channel_limit": 0,
"outbound_voice_profile_id": ""
}),
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/texml_applications/:id \
--header 'content-type: application/json' \
--data '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}'
echo '{
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": {
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
},
"outbound": {
"channel_limit": 0,
"outbound_voice_profile_id": ""
},
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
}' | \
http PATCH {{baseUrl}}/texml_applications/:id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "anchorsite_override": "",\n "dtmf_type": "",\n "first_command_timeout": false,\n "first_command_timeout_secs": 0,\n "friendly_name": "",\n "inbound": {\n "channel_limit": 0,\n "sip_subdomain": "",\n "sip_subdomain_receive_settings": ""\n },\n "outbound": {\n "channel_limit": 0,\n "outbound_voice_profile_id": ""\n },\n "status_callback": "",\n "status_callback_method": "",\n "voice_fallback_url": "",\n "voice_method": "",\n "voice_url": ""\n}' \
--output-document \
- {{baseUrl}}/texml_applications/:id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"anchorsite_override": "",
"dtmf_type": "",
"first_command_timeout": false,
"first_command_timeout_secs": 0,
"friendly_name": "",
"inbound": [
"channel_limit": 0,
"sip_subdomain": "",
"sip_subdomain_receive_settings": ""
],
"outbound": [
"channel_limit": 0,
"outbound_voice_profile_id": ""
],
"status_callback": "",
"status_callback_method": "",
"voice_fallback_url": "",
"voice_method": "",
"voice_url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/texml_applications/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"active": false,
"anchorsite_override": "Amsterdam, Netherlands",
"created_at": "2020-02-02T22:25:27.521Z",
"dtmf_type": "Inband",
"first_command_timeout": true,
"first_command_timeout_secs": 10,
"friendly_name": "call-router",
"id": "1293384261075731499",
"inbound": {
"channel_limit": 10,
"sip_subdomain": "example",
"sip_subdomain_receive_settings": "only_my_connections"
},
"outbound": {
"channel_limit": 10,
"outbound_voice_profile_id": "1293384261075731499"
},
"record_type": "texml_application",
"status_callback": "https://example.com",
"status_callback_method": "get",
"updated_at": "2020-02-03T22:25:27.521Z",
"voice_fallback_url": "https://fallback.example.com",
"voice_method": "get",
"voice_url": "https://example.com"
}
}
POST
Create a Verify profile
{{baseUrl}}/verify_profiles
BODY json
{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verify_profiles");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/verify_profiles" {:content-type :json
:form-params {:call {:default_call_timeout_secs 0
:default_verification_timeout_secs 0
:speech_template ""}
:flashcall {:default_verification_timeout_secs 0}
:language ""
:name ""
:psd2 {:default_verification_timeout_secs 0}
:sms {:default_verification_timeout_secs 0
:messaging_enabled false
:messaging_template ""
:rcs_enabled false
:vsms_enabled false}
:webhook_failover_url ""
:webhook_url ""
:whatsapp {:app_name ""
:default_verification_timeout_secs 0}}})
require "http/client"
url = "{{baseUrl}}/verify_profiles"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/verify_profiles"),
Content = new StringContent("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verify_profiles");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verify_profiles"
payload := strings.NewReader("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\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(res)
fmt.Println(string(body))
}
POST /baseUrl/verify_profiles HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 591
{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/verify_profiles")
.setHeader("content-type", "application/json")
.setBody("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verify_profiles"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/verify_profiles")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/verify_profiles")
.header("content-type", "application/json")
.body("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
.asString();
const data = JSON.stringify({
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {
default_verification_timeout_secs: 0
},
language: '',
name: '',
psd2: {
default_verification_timeout_secs: 0
},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {
app_name: '',
default_verification_timeout_secs: 0
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/verify_profiles');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/verify_profiles',
headers: {'content-type': 'application/json'},
data: {
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {default_verification_timeout_secs: 0},
language: '',
name: '',
psd2: {default_verification_timeout_secs: 0},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {app_name: '', default_verification_timeout_secs: 0}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verify_profiles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call":{"default_call_timeout_secs":0,"default_verification_timeout_secs":0,"speech_template":""},"flashcall":{"default_verification_timeout_secs":0},"language":"","name":"","psd2":{"default_verification_timeout_secs":0},"sms":{"default_verification_timeout_secs":0,"messaging_enabled":false,"messaging_template":"","rcs_enabled":false,"vsms_enabled":false},"webhook_failover_url":"","webhook_url":"","whatsapp":{"app_name":"","default_verification_timeout_secs":0}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verify_profiles',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call": {\n "default_call_timeout_secs": 0,\n "default_verification_timeout_secs": 0,\n "speech_template": ""\n },\n "flashcall": {\n "default_verification_timeout_secs": 0\n },\n "language": "",\n "name": "",\n "psd2": {\n "default_verification_timeout_secs": 0\n },\n "sms": {\n "default_verification_timeout_secs": 0,\n "messaging_enabled": false,\n "messaging_template": "",\n "rcs_enabled": false,\n "vsms_enabled": false\n },\n "webhook_failover_url": "",\n "webhook_url": "",\n "whatsapp": {\n "app_name": "",\n "default_verification_timeout_secs": 0\n }\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/verify_profiles")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/verify_profiles',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {default_verification_timeout_secs: 0},
language: '',
name: '',
psd2: {default_verification_timeout_secs: 0},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {app_name: '', default_verification_timeout_secs: 0}
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/verify_profiles',
headers: {'content-type': 'application/json'},
body: {
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {default_verification_timeout_secs: 0},
language: '',
name: '',
psd2: {default_verification_timeout_secs: 0},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {app_name: '', default_verification_timeout_secs: 0}
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/verify_profiles');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {
default_verification_timeout_secs: 0
},
language: '',
name: '',
psd2: {
default_verification_timeout_secs: 0
},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {
app_name: '',
default_verification_timeout_secs: 0
}
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/verify_profiles',
headers: {'content-type': 'application/json'},
data: {
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {default_verification_timeout_secs: 0},
language: '',
name: '',
psd2: {default_verification_timeout_secs: 0},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {app_name: '', default_verification_timeout_secs: 0}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verify_profiles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call":{"default_call_timeout_secs":0,"default_verification_timeout_secs":0,"speech_template":""},"flashcall":{"default_verification_timeout_secs":0},"language":"","name":"","psd2":{"default_verification_timeout_secs":0},"sms":{"default_verification_timeout_secs":0,"messaging_enabled":false,"messaging_template":"","rcs_enabled":false,"vsms_enabled":false},"webhook_failover_url":"","webhook_url":"","whatsapp":{"app_name":"","default_verification_timeout_secs":0}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call": @{ @"default_call_timeout_secs": @0, @"default_verification_timeout_secs": @0, @"speech_template": @"" },
@"flashcall": @{ @"default_verification_timeout_secs": @0 },
@"language": @"",
@"name": @"",
@"psd2": @{ @"default_verification_timeout_secs": @0 },
@"sms": @{ @"default_verification_timeout_secs": @0, @"messaging_enabled": @NO, @"messaging_template": @"", @"rcs_enabled": @NO, @"vsms_enabled": @NO },
@"webhook_failover_url": @"",
@"webhook_url": @"",
@"whatsapp": @{ @"app_name": @"", @"default_verification_timeout_secs": @0 } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verify_profiles"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verify_profiles" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verify_profiles",
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([
'call' => [
'default_call_timeout_secs' => 0,
'default_verification_timeout_secs' => 0,
'speech_template' => ''
],
'flashcall' => [
'default_verification_timeout_secs' => 0
],
'language' => '',
'name' => '',
'psd2' => [
'default_verification_timeout_secs' => 0
],
'sms' => [
'default_verification_timeout_secs' => 0,
'messaging_enabled' => null,
'messaging_template' => '',
'rcs_enabled' => null,
'vsms_enabled' => null
],
'webhook_failover_url' => '',
'webhook_url' => '',
'whatsapp' => [
'app_name' => '',
'default_verification_timeout_secs' => 0
]
]),
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;
}
request('POST', '{{baseUrl}}/verify_profiles', [
'body' => '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/verify_profiles');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call' => [
'default_call_timeout_secs' => 0,
'default_verification_timeout_secs' => 0,
'speech_template' => ''
],
'flashcall' => [
'default_verification_timeout_secs' => 0
],
'language' => '',
'name' => '',
'psd2' => [
'default_verification_timeout_secs' => 0
],
'sms' => [
'default_verification_timeout_secs' => 0,
'messaging_enabled' => null,
'messaging_template' => '',
'rcs_enabled' => null,
'vsms_enabled' => null
],
'webhook_failover_url' => '',
'webhook_url' => '',
'whatsapp' => [
'app_name' => '',
'default_verification_timeout_secs' => 0
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call' => [
'default_call_timeout_secs' => 0,
'default_verification_timeout_secs' => 0,
'speech_template' => ''
],
'flashcall' => [
'default_verification_timeout_secs' => 0
],
'language' => '',
'name' => '',
'psd2' => [
'default_verification_timeout_secs' => 0
],
'sms' => [
'default_verification_timeout_secs' => 0,
'messaging_enabled' => null,
'messaging_template' => '',
'rcs_enabled' => null,
'vsms_enabled' => null
],
'webhook_failover_url' => '',
'webhook_url' => '',
'whatsapp' => [
'app_name' => '',
'default_verification_timeout_secs' => 0
]
]));
$request->setRequestUrl('{{baseUrl}}/verify_profiles');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verify_profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verify_profiles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/verify_profiles", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verify_profiles"
payload = {
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": { "default_verification_timeout_secs": 0 },
"language": "",
"name": "",
"psd2": { "default_verification_timeout_secs": 0 },
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": False,
"messaging_template": "",
"rcs_enabled": False,
"vsms_enabled": False
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verify_profiles"
payload <- "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verify_profiles")
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 \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/verify_profiles') do |req|
req.body = "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verify_profiles";
let payload = json!({
"call": json!({
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
}),
"flashcall": json!({"default_verification_timeout_secs": 0}),
"language": "",
"name": "",
"psd2": json!({"default_verification_timeout_secs": 0}),
"sms": json!({
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
}),
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": json!({
"app_name": "",
"default_verification_timeout_secs": 0
})
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/verify_profiles \
--header 'content-type: application/json' \
--data '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}'
echo '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}' | \
http POST {{baseUrl}}/verify_profiles \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call": {\n "default_call_timeout_secs": 0,\n "default_verification_timeout_secs": 0,\n "speech_template": ""\n },\n "flashcall": {\n "default_verification_timeout_secs": 0\n },\n "language": "",\n "name": "",\n "psd2": {\n "default_verification_timeout_secs": 0\n },\n "sms": {\n "default_verification_timeout_secs": 0,\n "messaging_enabled": false,\n "messaging_template": "",\n "rcs_enabled": false,\n "vsms_enabled": false\n },\n "webhook_failover_url": "",\n "webhook_url": "",\n "whatsapp": {\n "app_name": "",\n "default_verification_timeout_secs": 0\n }\n}' \
--output-document \
- {{baseUrl}}/verify_profiles
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"call": [
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
],
"flashcall": ["default_verification_timeout_secs": 0],
"language": "",
"name": "",
"psd2": ["default_verification_timeout_secs": 0],
"sms": [
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
],
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": [
"app_name": "",
"default_verification_timeout_secs": 0
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verify_profiles")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"language": "en-US",
"name": "Test Profile",
"record_type": "verification_profile",
"updated_at": "2020-09-14T17:03:32.965812",
"webhook_failover_url": "http://example.com/webhook/failover",
"webhook_url": "http://example.com/webhook"
}
}
DELETE
Delete a Verify profile
{{baseUrl}}/verify_profiles/:verify_profile_id
QUERY PARAMS
verify_profile_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verify_profiles/:verify_profile_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/verify_profiles/:verify_profile_id")
require "http/client"
url = "{{baseUrl}}/verify_profiles/:verify_profile_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/verify_profiles/:verify_profile_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verify_profiles/:verify_profile_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verify_profiles/:verify_profile_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/verify_profiles/:verify_profile_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/verify_profiles/:verify_profile_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verify_profiles/:verify_profile_id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/verify_profiles/:verify_profile_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/verify_profiles/:verify_profile_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/verify_profiles/:verify_profile_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verify_profiles/:verify_profile_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verify_profiles/:verify_profile_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/verify_profiles/:verify_profile_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/verify_profiles/:verify_profile_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/verify_profiles/:verify_profile_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verify_profiles/:verify_profile_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verify_profiles/:verify_profile_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verify_profiles/:verify_profile_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verify_profiles/:verify_profile_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/verify_profiles/:verify_profile_id');
echo $response->getBody();
setUrl('{{baseUrl}}/verify_profiles/:verify_profile_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/verify_profiles/:verify_profile_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verify_profiles/:verify_profile_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verify_profiles/:verify_profile_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/verify_profiles/:verify_profile_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verify_profiles/:verify_profile_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verify_profiles/:verify_profile_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verify_profiles/:verify_profile_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/verify_profiles/:verify_profile_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verify_profiles/:verify_profile_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/verify_profiles/:verify_profile_id
http DELETE {{baseUrl}}/verify_profiles/:verify_profile_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/verify_profiles/:verify_profile_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verify_profiles/:verify_profile_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"language": "en-US",
"name": "Test Profile",
"record_type": "verification_profile",
"updated_at": "2020-09-14T17:03:32.965812",
"webhook_failover_url": "http://example.com/webhook/failover",
"webhook_url": "http://example.com/webhook"
}
}
GET
List all Verify profiles
{{baseUrl}}/verify_profiles
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verify_profiles");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/verify_profiles")
require "http/client"
url = "{{baseUrl}}/verify_profiles"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/verify_profiles"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verify_profiles");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verify_profiles"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/verify_profiles HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/verify_profiles")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verify_profiles"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/verify_profiles")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/verify_profiles")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/verify_profiles');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/verify_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verify_profiles';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verify_profiles',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/verify_profiles")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/verify_profiles',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/verify_profiles'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/verify_profiles');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/verify_profiles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verify_profiles';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verify_profiles"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verify_profiles" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verify_profiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/verify_profiles');
echo $response->getBody();
setUrl('{{baseUrl}}/verify_profiles');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/verify_profiles');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verify_profiles' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verify_profiles' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/verify_profiles")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verify_profiles"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verify_profiles"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verify_profiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/verify_profiles') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verify_profiles";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/verify_profiles
http GET {{baseUrl}}/verify_profiles
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/verify_profiles
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verify_profiles")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
List verifications by phone number
{{baseUrl}}/verifications/by_phone_number/:phone_number
QUERY PARAMS
phone_number
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verifications/by_phone_number/:phone_number");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/verifications/by_phone_number/:phone_number")
require "http/client"
url = "{{baseUrl}}/verifications/by_phone_number/:phone_number"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/verifications/by_phone_number/:phone_number"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verifications/by_phone_number/:phone_number");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verifications/by_phone_number/:phone_number"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/verifications/by_phone_number/:phone_number HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/verifications/by_phone_number/:phone_number")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verifications/by_phone_number/:phone_number"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/verifications/by_phone_number/:phone_number")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/verifications/by_phone_number/:phone_number")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/verifications/by_phone_number/:phone_number');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/verifications/by_phone_number/:phone_number'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verifications/by_phone_number/:phone_number';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verifications/by_phone_number/:phone_number',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/verifications/by_phone_number/:phone_number")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/verifications/by_phone_number/:phone_number',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/verifications/by_phone_number/:phone_number'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/verifications/by_phone_number/:phone_number');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/verifications/by_phone_number/:phone_number'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verifications/by_phone_number/:phone_number';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verifications/by_phone_number/:phone_number"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verifications/by_phone_number/:phone_number" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verifications/by_phone_number/:phone_number",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/verifications/by_phone_number/:phone_number');
echo $response->getBody();
setUrl('{{baseUrl}}/verifications/by_phone_number/:phone_number');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/verifications/by_phone_number/:phone_number');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verifications/by_phone_number/:phone_number' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verifications/by_phone_number/:phone_number' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/verifications/by_phone_number/:phone_number")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verifications/by_phone_number/:phone_number"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verifications/by_phone_number/:phone_number"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verifications/by_phone_number/:phone_number")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/verifications/by_phone_number/:phone_number') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verifications/by_phone_number/:phone_number";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/verifications/by_phone_number/:phone_number
http GET {{baseUrl}}/verifications/by_phone_number/:phone_number
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/verifications/by_phone_number/:phone_number
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verifications/by_phone_number/:phone_number")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Retrieve a Verify profile
{{baseUrl}}/verify_profiles/:verify_profile_id
QUERY PARAMS
verify_profile_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verify_profiles/:verify_profile_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/verify_profiles/:verify_profile_id")
require "http/client"
url = "{{baseUrl}}/verify_profiles/:verify_profile_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/verify_profiles/:verify_profile_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verify_profiles/:verify_profile_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verify_profiles/:verify_profile_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/verify_profiles/:verify_profile_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/verify_profiles/:verify_profile_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verify_profiles/:verify_profile_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/verify_profiles/:verify_profile_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/verify_profiles/:verify_profile_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/verify_profiles/:verify_profile_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verify_profiles/:verify_profile_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verify_profiles/:verify_profile_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/verify_profiles/:verify_profile_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/verify_profiles/:verify_profile_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/verify_profiles/:verify_profile_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verify_profiles/:verify_profile_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verify_profiles/:verify_profile_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verify_profiles/:verify_profile_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verify_profiles/:verify_profile_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/verify_profiles/:verify_profile_id');
echo $response->getBody();
setUrl('{{baseUrl}}/verify_profiles/:verify_profile_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/verify_profiles/:verify_profile_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verify_profiles/:verify_profile_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verify_profiles/:verify_profile_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/verify_profiles/:verify_profile_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verify_profiles/:verify_profile_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verify_profiles/:verify_profile_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verify_profiles/:verify_profile_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/verify_profiles/:verify_profile_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verify_profiles/:verify_profile_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/verify_profiles/:verify_profile_id
http GET {{baseUrl}}/verify_profiles/:verify_profile_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/verify_profiles/:verify_profile_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verify_profiles/:verify_profile_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"language": "en-US",
"name": "Test Profile",
"record_type": "verification_profile",
"updated_at": "2020-09-14T17:03:32.965812",
"webhook_failover_url": "http://example.com/webhook/failover",
"webhook_url": "http://example.com/webhook"
}
}
GET
Retrieve a verification
{{baseUrl}}/verifications/:verification_id
QUERY PARAMS
verification_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verifications/:verification_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/verifications/:verification_id")
require "http/client"
url = "{{baseUrl}}/verifications/:verification_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/verifications/:verification_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verifications/:verification_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verifications/:verification_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/verifications/:verification_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/verifications/:verification_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verifications/:verification_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/verifications/:verification_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/verifications/:verification_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/verifications/:verification_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/verifications/:verification_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verifications/:verification_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verifications/:verification_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/verifications/:verification_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/verifications/:verification_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/verifications/:verification_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/verifications/:verification_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/verifications/:verification_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verifications/:verification_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verifications/:verification_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verifications/:verification_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verifications/:verification_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/verifications/:verification_id');
echo $response->getBody();
setUrl('{{baseUrl}}/verifications/:verification_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/verifications/:verification_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verifications/:verification_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verifications/:verification_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/verifications/:verification_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verifications/:verification_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verifications/:verification_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verifications/:verification_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/verifications/:verification_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verifications/:verification_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/verifications/:verification_id
http GET {{baseUrl}}/verifications/:verification_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/verifications/:verification_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verifications/:verification_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_timeout_secs": 299,
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+13035551234",
"record_type": "verification",
"status": "accepted",
"timeout_secs": 300,
"updated_at": "2020-09-14T17:03:32.965812",
"verification_type": "sms_verification",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
}
POST
Submit a verification code
{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify
QUERY PARAMS
phone_number
BODY json
{
"code": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"code\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify" {:content-type :json
:form-params {:code ""}})
require "http/client"
url = "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"code\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify"),
Content = new StringContent("{\n \"code\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"code\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify"
payload := strings.NewReader("{\n \"code\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/verifications/by_phone_number/:phone_number/actions/verify HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 16
{
"code": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify")
.setHeader("content-type", "application/json")
.setBody("{\n \"code\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"code\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"code\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify")
.header("content-type", "application/json")
.body("{\n \"code\": \"\"\n}")
.asString();
const data = JSON.stringify({
code: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify',
headers: {'content-type': 'application/json'},
data: {code: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"code":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "code": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"code\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/verifications/by_phone_number/:phone_number/actions/verify',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({code: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify',
headers: {'content-type': 'application/json'},
body: {code: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
code: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify',
headers: {'content-type': 'application/json'},
data: {code: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"code":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"code": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"code\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify",
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([
'code' => ''
]),
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;
}
request('POST', '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify', [
'body' => '{
"code": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'code' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'code' => ''
]));
$request->setRequestUrl('{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"code": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"code": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"code\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/verifications/by_phone_number/:phone_number/actions/verify", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify"
payload = { "code": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify"
payload <- "{\n \"code\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify")
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 \"code\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/verifications/by_phone_number/:phone_number/actions/verify') do |req|
req.body = "{\n \"code\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify";
let payload = json!({"code": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify \
--header 'content-type: application/json' \
--data '{
"code": ""
}'
echo '{
"code": ""
}' | \
http POST {{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "code": ""\n}' \
--output-document \
- {{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["code": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verifications/by_phone_number/:phone_number/actions/verify")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"phone_number": "+13035551234",
"response_code": "accepted"
}
}
POST
Trigger a Call verification
{{baseUrl}}/verifications/call
BODY json
{
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verifications/call");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/verifications/call" {:content-type :json
:form-params {:call_timeout_secs 0
:phone_number ""
:timeout_secs 0
:verify_profile_id ""}})
require "http/client"
url = "{{baseUrl}}/verifications/call"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/verifications/call"),
Content = new StringContent("{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verifications/call");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verifications/call"
payload := strings.NewReader("{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/verifications/call HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 98
{
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/verifications/call")
.setHeader("content-type", "application/json")
.setBody("{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verifications/call"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/verifications/call")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/verifications/call")
.header("content-type", "application/json")
.body("{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
call_timeout_secs: 0,
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/verifications/call');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/call',
headers: {'content-type': 'application/json'},
data: {call_timeout_secs: 0, phone_number: '', timeout_secs: 0, verify_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verifications/call';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_timeout_secs":0,"phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verifications/call',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call_timeout_secs": 0,\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/verifications/call")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/verifications/call',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({call_timeout_secs: 0, phone_number: '', timeout_secs: 0, verify_profile_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/call',
headers: {'content-type': 'application/json'},
body: {call_timeout_secs: 0, phone_number: '', timeout_secs: 0, verify_profile_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/verifications/call');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call_timeout_secs: 0,
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/call',
headers: {'content-type': 'application/json'},
data: {call_timeout_secs: 0, phone_number: '', timeout_secs: 0, verify_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verifications/call';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"call_timeout_secs":0,"phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call_timeout_secs": @0,
@"phone_number": @"",
@"timeout_secs": @0,
@"verify_profile_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verifications/call"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verifications/call" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verifications/call",
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([
'call_timeout_secs' => 0,
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/verifications/call', [
'body' => '{
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/verifications/call');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call_timeout_secs' => 0,
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call_timeout_secs' => 0,
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/verifications/call');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verifications/call' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verifications/call' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/verifications/call", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verifications/call"
payload = {
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verifications/call"
payload <- "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verifications/call")
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 \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/verifications/call') do |req|
req.body = "{\n \"call_timeout_secs\": 0,\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verifications/call";
let payload = json!({
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/verifications/call \
--header 'content-type: application/json' \
--data '{
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
echo '{
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}' | \
http POST {{baseUrl}}/verifications/call \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "call_timeout_secs": 0,\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}' \
--output-document \
- {{baseUrl}}/verifications/call
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"call_timeout_secs": 0,
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verifications/call")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_timeout_secs": 299,
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+13035551234",
"record_type": "verification",
"status": "accepted",
"timeout_secs": 300,
"updated_at": "2020-09-14T17:03:32.965812",
"verification_type": "sms_verification",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
}
POST
Trigger a Flash call verification
{{baseUrl}}/verifications/flashcall
BODY json
{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verifications/flashcall");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/verifications/flashcall" {:content-type :json
:form-params {:phone_number ""
:timeout_secs 0
:verify_profile_id ""}})
require "http/client"
url = "{{baseUrl}}/verifications/flashcall"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/verifications/flashcall"),
Content = new StringContent("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verifications/flashcall");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verifications/flashcall"
payload := strings.NewReader("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/verifications/flashcall HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 72
{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/verifications/flashcall")
.setHeader("content-type", "application/json")
.setBody("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verifications/flashcall"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/verifications/flashcall")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/verifications/flashcall")
.header("content-type", "application/json")
.body("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/verifications/flashcall');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/flashcall',
headers: {'content-type': 'application/json'},
data: {phone_number: '', timeout_secs: 0, verify_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verifications/flashcall';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verifications/flashcall',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/verifications/flashcall")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/verifications/flashcall',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({phone_number: '', timeout_secs: 0, verify_profile_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/flashcall',
headers: {'content-type': 'application/json'},
body: {phone_number: '', timeout_secs: 0, verify_profile_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/verifications/flashcall');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/flashcall',
headers: {'content-type': 'application/json'},
data: {phone_number: '', timeout_secs: 0, verify_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verifications/flashcall';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"phone_number": @"",
@"timeout_secs": @0,
@"verify_profile_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verifications/flashcall"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verifications/flashcall" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verifications/flashcall",
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([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/verifications/flashcall', [
'body' => '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/verifications/flashcall');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/verifications/flashcall');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verifications/flashcall' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verifications/flashcall' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/verifications/flashcall", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verifications/flashcall"
payload = {
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verifications/flashcall"
payload <- "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verifications/flashcall")
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 \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/verifications/flashcall') do |req|
req.body = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verifications/flashcall";
let payload = json!({
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/verifications/flashcall \
--header 'content-type: application/json' \
--data '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
echo '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}' | \
http POST {{baseUrl}}/verifications/flashcall \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}' \
--output-document \
- {{baseUrl}}/verifications/flashcall
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verifications/flashcall")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_timeout_secs": 299,
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+13035551234",
"record_type": "verification",
"status": "accepted",
"timeout_secs": 300,
"updated_at": "2020-09-14T17:03:32.965812",
"verification_type": "sms_verification",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
}
POST
Trigger a PSD2 verification
{{baseUrl}}/verifications/psd2
BODY json
{
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verifications/psd2");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/verifications/psd2" {:content-type :json
:form-params {:amount ""
:currency ""
:payee ""
:phone_number ""
:timeout_secs 0
:verify_profile_id ""}})
require "http/client"
url = "{{baseUrl}}/verifications/psd2"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/verifications/psd2"),
Content = new StringContent("{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verifications/psd2");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verifications/psd2"
payload := strings.NewReader("{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/verifications/psd2 HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 121
{
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/verifications/psd2")
.setHeader("content-type", "application/json")
.setBody("{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verifications/psd2"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/verifications/psd2")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/verifications/psd2")
.header("content-type", "application/json")
.body("{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
amount: '',
currency: '',
payee: '',
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/verifications/psd2');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/psd2',
headers: {'content-type': 'application/json'},
data: {
amount: '',
currency: '',
payee: '',
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verifications/psd2';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"amount":"","currency":"","payee":"","phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verifications/psd2',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "amount": "",\n "currency": "",\n "payee": "",\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/verifications/psd2")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/verifications/psd2',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
amount: '',
currency: '',
payee: '',
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/psd2',
headers: {'content-type': 'application/json'},
body: {
amount: '',
currency: '',
payee: '',
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/verifications/psd2');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
amount: '',
currency: '',
payee: '',
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/psd2',
headers: {'content-type': 'application/json'},
data: {
amount: '',
currency: '',
payee: '',
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verifications/psd2';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"amount":"","currency":"","payee":"","phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"amount": @"",
@"currency": @"",
@"payee": @"",
@"phone_number": @"",
@"timeout_secs": @0,
@"verify_profile_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verifications/psd2"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verifications/psd2" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verifications/psd2",
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([
'amount' => '',
'currency' => '',
'payee' => '',
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/verifications/psd2', [
'body' => '{
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/verifications/psd2');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'amount' => '',
'currency' => '',
'payee' => '',
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'amount' => '',
'currency' => '',
'payee' => '',
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/verifications/psd2');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verifications/psd2' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verifications/psd2' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/verifications/psd2", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verifications/psd2"
payload = {
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verifications/psd2"
payload <- "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verifications/psd2")
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 \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/verifications/psd2') do |req|
req.body = "{\n \"amount\": \"\",\n \"currency\": \"\",\n \"payee\": \"\",\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verifications/psd2";
let payload = json!({
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/verifications/psd2 \
--header 'content-type: application/json' \
--data '{
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
echo '{
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}' | \
http POST {{baseUrl}}/verifications/psd2 \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "amount": "",\n "currency": "",\n "payee": "",\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}' \
--output-document \
- {{baseUrl}}/verifications/psd2
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"amount": "",
"currency": "",
"payee": "",
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verifications/psd2")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_timeout_secs": 299,
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+13035551234",
"record_type": "verification",
"status": "accepted",
"timeout_secs": 300,
"updated_at": "2020-09-14T17:03:32.965812",
"verification_type": "sms_verification",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
}
POST
Trigger a SMS verification
{{baseUrl}}/verifications/sms
BODY json
{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verifications/sms");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/verifications/sms" {:content-type :json
:form-params {:phone_number ""
:timeout_secs 0
:verify_profile_id ""}})
require "http/client"
url = "{{baseUrl}}/verifications/sms"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/verifications/sms"),
Content = new StringContent("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verifications/sms");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verifications/sms"
payload := strings.NewReader("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/verifications/sms HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 72
{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/verifications/sms")
.setHeader("content-type", "application/json")
.setBody("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verifications/sms"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/verifications/sms")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/verifications/sms")
.header("content-type", "application/json")
.body("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/verifications/sms');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/sms',
headers: {'content-type': 'application/json'},
data: {phone_number: '', timeout_secs: 0, verify_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verifications/sms';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verifications/sms',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/verifications/sms")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/verifications/sms',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({phone_number: '', timeout_secs: 0, verify_profile_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/sms',
headers: {'content-type': 'application/json'},
body: {phone_number: '', timeout_secs: 0, verify_profile_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/verifications/sms');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/sms',
headers: {'content-type': 'application/json'},
data: {phone_number: '', timeout_secs: 0, verify_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verifications/sms';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"phone_number": @"",
@"timeout_secs": @0,
@"verify_profile_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verifications/sms"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verifications/sms" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verifications/sms",
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([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/verifications/sms', [
'body' => '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/verifications/sms');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/verifications/sms');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verifications/sms' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verifications/sms' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/verifications/sms", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verifications/sms"
payload = {
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verifications/sms"
payload <- "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verifications/sms")
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 \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/verifications/sms') do |req|
req.body = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verifications/sms";
let payload = json!({
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/verifications/sms \
--header 'content-type: application/json' \
--data '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
echo '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}' | \
http POST {{baseUrl}}/verifications/sms \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}' \
--output-document \
- {{baseUrl}}/verifications/sms
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verifications/sms")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_timeout_secs": 299,
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+13035551234",
"record_type": "verification",
"status": "accepted",
"timeout_secs": 300,
"updated_at": "2020-09-14T17:03:32.965812",
"verification_type": "sms_verification",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
}
POST
Trigger a Whatsapp verification
{{baseUrl}}/verifications/whatsapp
BODY json
{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verifications/whatsapp");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/verifications/whatsapp" {:content-type :json
:form-params {:phone_number ""
:timeout_secs 0
:verify_profile_id ""}})
require "http/client"
url = "{{baseUrl}}/verifications/whatsapp"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/verifications/whatsapp"),
Content = new StringContent("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verifications/whatsapp");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verifications/whatsapp"
payload := strings.NewReader("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/verifications/whatsapp HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 72
{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/verifications/whatsapp")
.setHeader("content-type", "application/json")
.setBody("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verifications/whatsapp"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/verifications/whatsapp")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/verifications/whatsapp")
.header("content-type", "application/json")
.body("{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/verifications/whatsapp');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/whatsapp',
headers: {'content-type': 'application/json'},
data: {phone_number: '', timeout_secs: 0, verify_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verifications/whatsapp';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verifications/whatsapp',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/verifications/whatsapp")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/verifications/whatsapp',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({phone_number: '', timeout_secs: 0, verify_profile_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/whatsapp',
headers: {'content-type': 'application/json'},
body: {phone_number: '', timeout_secs: 0, verify_profile_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/verifications/whatsapp');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
phone_number: '',
timeout_secs: 0,
verify_profile_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/verifications/whatsapp',
headers: {'content-type': 'application/json'},
data: {phone_number: '', timeout_secs: 0, verify_profile_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verifications/whatsapp';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"phone_number":"","timeout_secs":0,"verify_profile_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"phone_number": @"",
@"timeout_secs": @0,
@"verify_profile_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verifications/whatsapp"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verifications/whatsapp" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verifications/whatsapp",
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([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/verifications/whatsapp', [
'body' => '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/verifications/whatsapp');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'phone_number' => '',
'timeout_secs' => 0,
'verify_profile_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/verifications/whatsapp');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verifications/whatsapp' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verifications/whatsapp' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/verifications/whatsapp", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verifications/whatsapp"
payload = {
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verifications/whatsapp"
payload <- "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verifications/whatsapp")
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 \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/verifications/whatsapp') do |req|
req.body = "{\n \"phone_number\": \"\",\n \"timeout_secs\": 0,\n \"verify_profile_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verifications/whatsapp";
let payload = json!({
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/verifications/whatsapp \
--header 'content-type: application/json' \
--data '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}'
echo '{
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
}' | \
http POST {{baseUrl}}/verifications/whatsapp \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "phone_number": "",\n "timeout_secs": 0,\n "verify_profile_id": ""\n}' \
--output-document \
- {{baseUrl}}/verifications/whatsapp
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"phone_number": "",
"timeout_secs": 0,
"verify_profile_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verifications/whatsapp")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"call_timeout_secs": 299,
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"phone_number": "+13035551234",
"record_type": "verification",
"status": "accepted",
"timeout_secs": 300,
"updated_at": "2020-09-14T17:03:32.965812",
"verification_type": "sms_verification",
"verify_profile_id": "12ade33a-21c0-473b-b055-b3c836e1c292"
}
}
PATCH
Update a Verify profile
{{baseUrl}}/verify_profiles/:verify_profile_id
QUERY PARAMS
verify_profile_id
BODY json
{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/verify_profiles/:verify_profile_id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/verify_profiles/:verify_profile_id" {:content-type :json
:form-params {:call {:default_call_timeout_secs 0
:default_verification_timeout_secs 0
:speech_template ""}
:flashcall {:default_verification_timeout_secs 0}
:language ""
:name ""
:psd2 {:default_verification_timeout_secs 0}
:sms {:default_verification_timeout_secs 0
:messaging_enabled false
:messaging_template ""
:rcs_enabled false
:vsms_enabled false}
:webhook_failover_url ""
:webhook_url ""
:whatsapp {:app_name ""
:default_verification_timeout_secs 0}}})
require "http/client"
url = "{{baseUrl}}/verify_profiles/:verify_profile_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/verify_profiles/:verify_profile_id"),
Content = new StringContent("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/verify_profiles/:verify_profile_id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/verify_profiles/:verify_profile_id"
payload := strings.NewReader("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/verify_profiles/:verify_profile_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 591
{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/verify_profiles/:verify_profile_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/verify_profiles/:verify_profile_id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/verify_profiles/:verify_profile_id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/verify_profiles/:verify_profile_id")
.header("content-type", "application/json")
.body("{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
.asString();
const data = JSON.stringify({
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {
default_verification_timeout_secs: 0
},
language: '',
name: '',
psd2: {
default_verification_timeout_secs: 0
},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {
app_name: '',
default_verification_timeout_secs: 0
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/verify_profiles/:verify_profile_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id',
headers: {'content-type': 'application/json'},
data: {
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {default_verification_timeout_secs: 0},
language: '',
name: '',
psd2: {default_verification_timeout_secs: 0},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {app_name: '', default_verification_timeout_secs: 0}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/verify_profiles/:verify_profile_id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"call":{"default_call_timeout_secs":0,"default_verification_timeout_secs":0,"speech_template":""},"flashcall":{"default_verification_timeout_secs":0},"language":"","name":"","psd2":{"default_verification_timeout_secs":0},"sms":{"default_verification_timeout_secs":0,"messaging_enabled":false,"messaging_template":"","rcs_enabled":false,"vsms_enabled":false},"webhook_failover_url":"","webhook_url":"","whatsapp":{"app_name":"","default_verification_timeout_secs":0}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/verify_profiles/:verify_profile_id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "call": {\n "default_call_timeout_secs": 0,\n "default_verification_timeout_secs": 0,\n "speech_template": ""\n },\n "flashcall": {\n "default_verification_timeout_secs": 0\n },\n "language": "",\n "name": "",\n "psd2": {\n "default_verification_timeout_secs": 0\n },\n "sms": {\n "default_verification_timeout_secs": 0,\n "messaging_enabled": false,\n "messaging_template": "",\n "rcs_enabled": false,\n "vsms_enabled": false\n },\n "webhook_failover_url": "",\n "webhook_url": "",\n "whatsapp": {\n "app_name": "",\n "default_verification_timeout_secs": 0\n }\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/verify_profiles/:verify_profile_id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/verify_profiles/:verify_profile_id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {default_verification_timeout_secs: 0},
language: '',
name: '',
psd2: {default_verification_timeout_secs: 0},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {app_name: '', default_verification_timeout_secs: 0}
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id',
headers: {'content-type': 'application/json'},
body: {
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {default_verification_timeout_secs: 0},
language: '',
name: '',
psd2: {default_verification_timeout_secs: 0},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {app_name: '', default_verification_timeout_secs: 0}
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/verify_profiles/:verify_profile_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {
default_verification_timeout_secs: 0
},
language: '',
name: '',
psd2: {
default_verification_timeout_secs: 0
},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {
app_name: '',
default_verification_timeout_secs: 0
}
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/verify_profiles/:verify_profile_id',
headers: {'content-type': 'application/json'},
data: {
call: {
default_call_timeout_secs: 0,
default_verification_timeout_secs: 0,
speech_template: ''
},
flashcall: {default_verification_timeout_secs: 0},
language: '',
name: '',
psd2: {default_verification_timeout_secs: 0},
sms: {
default_verification_timeout_secs: 0,
messaging_enabled: false,
messaging_template: '',
rcs_enabled: false,
vsms_enabled: false
},
webhook_failover_url: '',
webhook_url: '',
whatsapp: {app_name: '', default_verification_timeout_secs: 0}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/verify_profiles/:verify_profile_id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"call":{"default_call_timeout_secs":0,"default_verification_timeout_secs":0,"speech_template":""},"flashcall":{"default_verification_timeout_secs":0},"language":"","name":"","psd2":{"default_verification_timeout_secs":0},"sms":{"default_verification_timeout_secs":0,"messaging_enabled":false,"messaging_template":"","rcs_enabled":false,"vsms_enabled":false},"webhook_failover_url":"","webhook_url":"","whatsapp":{"app_name":"","default_verification_timeout_secs":0}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"call": @{ @"default_call_timeout_secs": @0, @"default_verification_timeout_secs": @0, @"speech_template": @"" },
@"flashcall": @{ @"default_verification_timeout_secs": @0 },
@"language": @"",
@"name": @"",
@"psd2": @{ @"default_verification_timeout_secs": @0 },
@"sms": @{ @"default_verification_timeout_secs": @0, @"messaging_enabled": @NO, @"messaging_template": @"", @"rcs_enabled": @NO, @"vsms_enabled": @NO },
@"webhook_failover_url": @"",
@"webhook_url": @"",
@"whatsapp": @{ @"app_name": @"", @"default_verification_timeout_secs": @0 } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/verify_profiles/:verify_profile_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/verify_profiles/:verify_profile_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/verify_profiles/:verify_profile_id",
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([
'call' => [
'default_call_timeout_secs' => 0,
'default_verification_timeout_secs' => 0,
'speech_template' => ''
],
'flashcall' => [
'default_verification_timeout_secs' => 0
],
'language' => '',
'name' => '',
'psd2' => [
'default_verification_timeout_secs' => 0
],
'sms' => [
'default_verification_timeout_secs' => 0,
'messaging_enabled' => null,
'messaging_template' => '',
'rcs_enabled' => null,
'vsms_enabled' => null
],
'webhook_failover_url' => '',
'webhook_url' => '',
'whatsapp' => [
'app_name' => '',
'default_verification_timeout_secs' => 0
]
]),
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;
}
request('PATCH', '{{baseUrl}}/verify_profiles/:verify_profile_id', [
'body' => '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/verify_profiles/:verify_profile_id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'call' => [
'default_call_timeout_secs' => 0,
'default_verification_timeout_secs' => 0,
'speech_template' => ''
],
'flashcall' => [
'default_verification_timeout_secs' => 0
],
'language' => '',
'name' => '',
'psd2' => [
'default_verification_timeout_secs' => 0
],
'sms' => [
'default_verification_timeout_secs' => 0,
'messaging_enabled' => null,
'messaging_template' => '',
'rcs_enabled' => null,
'vsms_enabled' => null
],
'webhook_failover_url' => '',
'webhook_url' => '',
'whatsapp' => [
'app_name' => '',
'default_verification_timeout_secs' => 0
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'call' => [
'default_call_timeout_secs' => 0,
'default_verification_timeout_secs' => 0,
'speech_template' => ''
],
'flashcall' => [
'default_verification_timeout_secs' => 0
],
'language' => '',
'name' => '',
'psd2' => [
'default_verification_timeout_secs' => 0
],
'sms' => [
'default_verification_timeout_secs' => 0,
'messaging_enabled' => null,
'messaging_template' => '',
'rcs_enabled' => null,
'vsms_enabled' => null
],
'webhook_failover_url' => '',
'webhook_url' => '',
'whatsapp' => [
'app_name' => '',
'default_verification_timeout_secs' => 0
]
]));
$request->setRequestUrl('{{baseUrl}}/verify_profiles/:verify_profile_id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/verify_profiles/:verify_profile_id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/verify_profiles/:verify_profile_id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/verify_profiles/:verify_profile_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/verify_profiles/:verify_profile_id"
payload = {
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": { "default_verification_timeout_secs": 0 },
"language": "",
"name": "",
"psd2": { "default_verification_timeout_secs": 0 },
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": False,
"messaging_template": "",
"rcs_enabled": False,
"vsms_enabled": False
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/verify_profiles/:verify_profile_id"
payload <- "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/verify_profiles/:verify_profile_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/verify_profiles/:verify_profile_id') do |req|
req.body = "{\n \"call\": {\n \"default_call_timeout_secs\": 0,\n \"default_verification_timeout_secs\": 0,\n \"speech_template\": \"\"\n },\n \"flashcall\": {\n \"default_verification_timeout_secs\": 0\n },\n \"language\": \"\",\n \"name\": \"\",\n \"psd2\": {\n \"default_verification_timeout_secs\": 0\n },\n \"sms\": {\n \"default_verification_timeout_secs\": 0,\n \"messaging_enabled\": false,\n \"messaging_template\": \"\",\n \"rcs_enabled\": false,\n \"vsms_enabled\": false\n },\n \"webhook_failover_url\": \"\",\n \"webhook_url\": \"\",\n \"whatsapp\": {\n \"app_name\": \"\",\n \"default_verification_timeout_secs\": 0\n }\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/verify_profiles/:verify_profile_id";
let payload = json!({
"call": json!({
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
}),
"flashcall": json!({"default_verification_timeout_secs": 0}),
"language": "",
"name": "",
"psd2": json!({"default_verification_timeout_secs": 0}),
"sms": json!({
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
}),
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": json!({
"app_name": "",
"default_verification_timeout_secs": 0
})
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/verify_profiles/:verify_profile_id \
--header 'content-type: application/json' \
--data '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}'
echo '{
"call": {
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
},
"flashcall": {
"default_verification_timeout_secs": 0
},
"language": "",
"name": "",
"psd2": {
"default_verification_timeout_secs": 0
},
"sms": {
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
},
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": {
"app_name": "",
"default_verification_timeout_secs": 0
}
}' | \
http PATCH {{baseUrl}}/verify_profiles/:verify_profile_id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "call": {\n "default_call_timeout_secs": 0,\n "default_verification_timeout_secs": 0,\n "speech_template": ""\n },\n "flashcall": {\n "default_verification_timeout_secs": 0\n },\n "language": "",\n "name": "",\n "psd2": {\n "default_verification_timeout_secs": 0\n },\n "sms": {\n "default_verification_timeout_secs": 0,\n "messaging_enabled": false,\n "messaging_template": "",\n "rcs_enabled": false,\n "vsms_enabled": false\n },\n "webhook_failover_url": "",\n "webhook_url": "",\n "whatsapp": {\n "app_name": "",\n "default_verification_timeout_secs": 0\n }\n}' \
--output-document \
- {{baseUrl}}/verify_profiles/:verify_profile_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"call": [
"default_call_timeout_secs": 0,
"default_verification_timeout_secs": 0,
"speech_template": ""
],
"flashcall": ["default_verification_timeout_secs": 0],
"language": "",
"name": "",
"psd2": ["default_verification_timeout_secs": 0],
"sms": [
"default_verification_timeout_secs": 0,
"messaging_enabled": false,
"messaging_template": "",
"rcs_enabled": false,
"vsms_enabled": false
],
"webhook_failover_url": "",
"webhook_url": "",
"whatsapp": [
"app_name": "",
"default_verification_timeout_secs": 0
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/verify_profiles/:verify_profile_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-09-14T17:03:32.965812",
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"language": "en-US",
"name": "Test Profile",
"record_type": "verification_profile",
"updated_at": "2020-09-14T17:03:32.965812",
"webhook_failover_url": "http://example.com/webhook/failover",
"webhook_url": "http://example.com/webhook"
}
}
GET
getPaginatedWdrs
{{baseUrl}}/reports/wdrs
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/wdrs");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/wdrs")
require "http/client"
url = "{{baseUrl}}/reports/wdrs"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/wdrs"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/wdrs");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/wdrs"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/wdrs HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/wdrs")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/wdrs"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/wdrs")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/wdrs")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/reports/wdrs');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/reports/wdrs'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/wdrs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/reports/wdrs',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/wdrs")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/wdrs',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/reports/wdrs'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/wdrs');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/reports/wdrs'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/wdrs';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/wdrs"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/reports/wdrs" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/wdrs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/reports/wdrs');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/wdrs');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/wdrs');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/wdrs' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/wdrs' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/wdrs")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/wdrs"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/wdrs"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/wdrs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/wdrs') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/wdrs";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/wdrs
http GET {{baseUrl}}/reports/wdrs
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/wdrs
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/wdrs")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
GET
Find webhook_delivery details by ID
{{baseUrl}}/webhook_deliveries/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhook_deliveries/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/webhook_deliveries/:id")
require "http/client"
url = "{{baseUrl}}/webhook_deliveries/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/webhook_deliveries/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/webhook_deliveries/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhook_deliveries/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/webhook_deliveries/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/webhook_deliveries/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhook_deliveries/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/webhook_deliveries/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/webhook_deliveries/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/webhook_deliveries/:id');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/webhook_deliveries/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/webhook_deliveries/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/webhook_deliveries/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/webhook_deliveries/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/webhook_deliveries/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/webhook_deliveries/:id'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/webhook_deliveries/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/webhook_deliveries/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhook_deliveries/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhook_deliveries/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/webhook_deliveries/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/webhook_deliveries/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/webhook_deliveries/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/webhook_deliveries/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/webhook_deliveries/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/webhook_deliveries/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhook_deliveries/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/webhook_deliveries/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/webhook_deliveries/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/webhook_deliveries/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/webhook_deliveries/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/webhook_deliveries/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhook_deliveries/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/webhook_deliveries/:id
http GET {{baseUrl}}/webhook_deliveries/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/webhook_deliveries/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhook_deliveries/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
List webhook deliveries
{{baseUrl}}/webhook_deliveries
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhook_deliveries");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/webhook_deliveries")
require "http/client"
url = "{{baseUrl}}/webhook_deliveries"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/webhook_deliveries"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/webhook_deliveries");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhook_deliveries"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/webhook_deliveries HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/webhook_deliveries")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhook_deliveries"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/webhook_deliveries")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/webhook_deliveries")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/webhook_deliveries');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/webhook_deliveries'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/webhook_deliveries';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/webhook_deliveries',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/webhook_deliveries")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/webhook_deliveries',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/webhook_deliveries'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/webhook_deliveries');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/webhook_deliveries'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhook_deliveries';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhook_deliveries"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/webhook_deliveries" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/webhook_deliveries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/webhook_deliveries');
echo $response->getBody();
setUrl('{{baseUrl}}/webhook_deliveries');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/webhook_deliveries');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/webhook_deliveries' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhook_deliveries' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/webhook_deliveries")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/webhook_deliveries"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/webhook_deliveries"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/webhook_deliveries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/webhook_deliveries') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhook_deliveries";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/webhook_deliveries
http GET {{baseUrl}}/webhook_deliveries
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/webhook_deliveries
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhook_deliveries")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
Check Contact
{{baseUrl}}/whatsapp_contacts
BODY json
{
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_contacts");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/whatsapp_contacts" {:content-type :json
:form-params {:blocking ""
:contacts []
:whatsapp_user_id ""}})
require "http/client"
url = "{{baseUrl}}/whatsapp_contacts"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/whatsapp_contacts"),
Content = new StringContent("{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_contacts");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_contacts"
payload := strings.NewReader("{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/whatsapp_contacts HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 64
{
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/whatsapp_contacts")
.setHeader("content-type", "application/json")
.setBody("{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_contacts"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_contacts")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/whatsapp_contacts")
.header("content-type", "application/json")
.body("{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
blocking: '',
contacts: [],
whatsapp_user_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/whatsapp_contacts');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_contacts',
headers: {'content-type': 'application/json'},
data: {blocking: '', contacts: [], whatsapp_user_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_contacts';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"blocking":"","contacts":[],"whatsapp_user_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_contacts',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "blocking": "",\n "contacts": [],\n "whatsapp_user_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_contacts")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_contacts',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({blocking: '', contacts: [], whatsapp_user_id: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_contacts',
headers: {'content-type': 'application/json'},
body: {blocking: '', contacts: [], whatsapp_user_id: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/whatsapp_contacts');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
blocking: '',
contacts: [],
whatsapp_user_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_contacts',
headers: {'content-type': 'application/json'},
data: {blocking: '', contacts: [], whatsapp_user_id: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_contacts';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"blocking":"","contacts":[],"whatsapp_user_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"blocking": @"",
@"contacts": @[ ],
@"whatsapp_user_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_contacts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_contacts" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_contacts",
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([
'blocking' => '',
'contacts' => [
],
'whatsapp_user_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/whatsapp_contacts', [
'body' => '{
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_contacts');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'blocking' => '',
'contacts' => [
],
'whatsapp_user_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'blocking' => '',
'contacts' => [
],
'whatsapp_user_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/whatsapp_contacts');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_contacts' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_contacts' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/whatsapp_contacts", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_contacts"
payload = {
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_contacts"
payload <- "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_contacts")
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 \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/whatsapp_contacts') do |req|
req.body = "{\n \"blocking\": \"\",\n \"contacts\": [],\n \"whatsapp_user_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_contacts";
let payload = json!({
"blocking": "",
"contacts": (),
"whatsapp_user_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/whatsapp_contacts \
--header 'content-type: application/json' \
--data '{
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
}'
echo '{
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
}' | \
http POST {{baseUrl}}/whatsapp_contacts \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "blocking": "",\n "contacts": [],\n "whatsapp_user_id": ""\n}' \
--output-document \
- {{baseUrl}}/whatsapp_contacts
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"blocking": "",
"contacts": [],
"whatsapp_user_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_contacts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "15125551234",
"input": "+1 (512) 555-1234",
"record_type": "whatsapp_contact",
"status": "valid"
}
]
}
DELETE
deleteRequest
{{baseUrl}}/whatsapp_detail_record_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_detail_record_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/whatsapp_detail_record_reports/:id")
require "http/client"
url = "{{baseUrl}}/whatsapp_detail_record_reports/:id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/whatsapp_detail_record_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_detail_record_reports/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_detail_record_reports/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/whatsapp_detail_record_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/whatsapp_detail_record_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_detail_record_reports/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_detail_record_reports/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/whatsapp_detail_record_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/whatsapp_detail_record_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/whatsapp_detail_record_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_detail_record_reports/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_detail_record_reports/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_detail_record_reports/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_detail_record_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/whatsapp_detail_record_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/whatsapp_detail_record_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/whatsapp_detail_record_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_detail_record_reports/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_detail_record_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_detail_record_reports/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_detail_record_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/whatsapp_detail_record_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_detail_record_reports/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/whatsapp_detail_record_reports/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_detail_record_reports/:id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_detail_record_reports/:id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/whatsapp_detail_record_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_detail_record_reports/:id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_detail_record_reports/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_detail_record_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/whatsapp_detail_record_reports/:id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_detail_record_reports/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/whatsapp_detail_record_reports/:id
http DELETE {{baseUrl}}/whatsapp_detail_record_reports/:id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/whatsapp_detail_record_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_detail_record_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-05-01T00:00:00-06:00",
"download_link": "https://portal-cdrs-usage.s3.amazonaws.com",
"end_date": "2020-05-01T00:00:00-06:00",
"id": "ab76c3b6-80cd-11eb-9439-0242ac130002",
"record_type": "whatsapp_detail_record_report",
"start_date": "2020-05-01T00:00:00-06:00"
}
}
GET
getRequest
{{baseUrl}}/whatsapp_detail_record_reports/:id
QUERY PARAMS
id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_detail_record_reports/:id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/whatsapp_detail_record_reports/:id")
require "http/client"
url = "{{baseUrl}}/whatsapp_detail_record_reports/:id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/whatsapp_detail_record_reports/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_detail_record_reports/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_detail_record_reports/:id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/whatsapp_detail_record_reports/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/whatsapp_detail_record_reports/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_detail_record_reports/:id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_detail_record_reports/:id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/whatsapp_detail_record_reports/:id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/whatsapp_detail_record_reports/:id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_detail_record_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_detail_record_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_detail_record_reports/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_detail_record_reports/:id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_detail_record_reports/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_detail_record_reports/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/whatsapp_detail_record_reports/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_detail_record_reports/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_detail_record_reports/:id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_detail_record_reports/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_detail_record_reports/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_detail_record_reports/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/whatsapp_detail_record_reports/:id');
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_detail_record_reports/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/whatsapp_detail_record_reports/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_detail_record_reports/:id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_detail_record_reports/:id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/whatsapp_detail_record_reports/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_detail_record_reports/:id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_detail_record_reports/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_detail_record_reports/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/whatsapp_detail_record_reports/:id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_detail_record_reports/:id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/whatsapp_detail_record_reports/:id
http GET {{baseUrl}}/whatsapp_detail_record_reports/:id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/whatsapp_detail_record_reports/:id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_detail_record_reports/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-05-01T00:00:00-06:00",
"download_link": "https://portal-cdrs-usage.s3.amazonaws.com",
"end_date": "2020-05-01T00:00:00-06:00",
"id": "ab76c3b6-80cd-11eb-9439-0242ac130002",
"record_type": "whatsapp_detail_record_report",
"start_date": "2020-05-01T00:00:00-06:00"
}
}
GET
getRequests
{{baseUrl}}/whatsapp_detail_record_reports
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_detail_record_reports");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/whatsapp_detail_record_reports")
require "http/client"
url = "{{baseUrl}}/whatsapp_detail_record_reports"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/whatsapp_detail_record_reports"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_detail_record_reports");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_detail_record_reports"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/whatsapp_detail_record_reports HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/whatsapp_detail_record_reports")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_detail_record_reports"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_detail_record_reports")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/whatsapp_detail_record_reports")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/whatsapp_detail_record_reports');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_detail_record_reports'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_detail_record_reports';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_detail_record_reports',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_detail_record_reports")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_detail_record_reports',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_detail_record_reports'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/whatsapp_detail_record_reports');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_detail_record_reports'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_detail_record_reports';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_detail_record_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_detail_record_reports" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_detail_record_reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/whatsapp_detail_record_reports');
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_detail_record_reports');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/whatsapp_detail_record_reports');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_detail_record_reports' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_detail_record_reports' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/whatsapp_detail_record_reports")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_detail_record_reports"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_detail_record_reports"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_detail_record_reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/whatsapp_detail_record_reports') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_detail_record_reports";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/whatsapp_detail_record_reports
http GET {{baseUrl}}/whatsapp_detail_record_reports
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/whatsapp_detail_record_reports
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_detail_record_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}
POST
submitRequest
{{baseUrl}}/whatsapp_detail_record_reports
BODY json
{
"end_date": "",
"start_date": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_detail_record_reports");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/whatsapp_detail_record_reports" {:content-type :json
:form-params {:end_date ""
:start_date ""}})
require "http/client"
url = "{{baseUrl}}/whatsapp_detail_record_reports"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/whatsapp_detail_record_reports"),
Content = new StringContent("{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_detail_record_reports");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_detail_record_reports"
payload := strings.NewReader("{\n \"end_date\": \"\",\n \"start_date\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/whatsapp_detail_record_reports HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 40
{
"end_date": "",
"start_date": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/whatsapp_detail_record_reports")
.setHeader("content-type", "application/json")
.setBody("{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_detail_record_reports"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_detail_record_reports")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/whatsapp_detail_record_reports")
.header("content-type", "application/json")
.body("{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}")
.asString();
const data = JSON.stringify({
end_date: '',
start_date: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/whatsapp_detail_record_reports');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_detail_record_reports',
headers: {'content-type': 'application/json'},
data: {end_date: '', start_date: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_detail_record_reports';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"end_date":"","start_date":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_detail_record_reports',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "end_date": "",\n "start_date": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_detail_record_reports")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_detail_record_reports',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({end_date: '', start_date: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_detail_record_reports',
headers: {'content-type': 'application/json'},
body: {end_date: '', start_date: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/whatsapp_detail_record_reports');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
end_date: '',
start_date: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_detail_record_reports',
headers: {'content-type': 'application/json'},
data: {end_date: '', start_date: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_detail_record_reports';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"end_date":"","start_date":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"end_date": @"",
@"start_date": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_detail_record_reports"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_detail_record_reports" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_detail_record_reports",
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([
'end_date' => '',
'start_date' => ''
]),
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;
}
request('POST', '{{baseUrl}}/whatsapp_detail_record_reports', [
'body' => '{
"end_date": "",
"start_date": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_detail_record_reports');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'end_date' => '',
'start_date' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'end_date' => '',
'start_date' => ''
]));
$request->setRequestUrl('{{baseUrl}}/whatsapp_detail_record_reports');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_detail_record_reports' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"end_date": "",
"start_date": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_detail_record_reports' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"end_date": "",
"start_date": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/whatsapp_detail_record_reports", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_detail_record_reports"
payload = {
"end_date": "",
"start_date": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_detail_record_reports"
payload <- "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_detail_record_reports")
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 \"end_date\": \"\",\n \"start_date\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/whatsapp_detail_record_reports') do |req|
req.body = "{\n \"end_date\": \"\",\n \"start_date\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_detail_record_reports";
let payload = json!({
"end_date": "",
"start_date": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/whatsapp_detail_record_reports \
--header 'content-type: application/json' \
--data '{
"end_date": "",
"start_date": ""
}'
echo '{
"end_date": "",
"start_date": ""
}' | \
http POST {{baseUrl}}/whatsapp_detail_record_reports \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "end_date": "",\n "start_date": ""\n}' \
--output-document \
- {{baseUrl}}/whatsapp_detail_record_reports
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"end_date": "",
"start_date": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_detail_record_reports")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"created_at": "2020-05-01T00:00:00-06:00",
"download_link": "https://portal-cdrs-usage.s3.amazonaws.com",
"end_date": "2020-05-01T00:00:00-06:00",
"id": "ab76c3b6-80cd-11eb-9439-0242ac130002",
"record_type": "whatsapp_detail_record_report",
"start_date": "2020-05-01T00:00:00-06:00"
}
}
DELETE
Delete Media
{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id
QUERY PARAMS
whatsapp_user_id
media_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
require "http/client"
url = "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/whatsapp_media/:whatsapp_user_id/:media_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_media/:whatsapp_user_id/:media_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/whatsapp_media/:whatsapp_user_id/:media_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/whatsapp_media/:whatsapp_user_id/:media_id') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id
http DELETE {{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Download Media
{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id
QUERY PARAMS
whatsapp_user_id
media_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
require "http/client"
url = "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/whatsapp_media/:whatsapp_user_id/:media_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_media/:whatsapp_user_id/:media_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/whatsapp_media/:whatsapp_user_id/:media_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/whatsapp_media/:whatsapp_user_id/:media_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id
http GET {{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_media/:whatsapp_user_id/:media_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Upload Media
{{baseUrl}}/whatsapp_media
BODY multipartForm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_media");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: multipart/form-data; boundary=---011000010111000001101001");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/whatsapp_media" {:multipart [{:name "media_content_type"
:content ""} {:name "upload_file"
:content ""} {:name "whatsapp_user_id"
:content ""}]})
require "http/client"
url = "{{baseUrl}}/whatsapp_media"
headers = HTTP::Headers{
"content-type" => "multipart/form-data; boundary=---011000010111000001101001"
}
reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/whatsapp_media"),
Content = new MultipartFormDataContent
{
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "media_content_type",
}
}
},
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "upload_file",
}
}
},
new StringContent("")
{
Headers =
{
ContentDisposition = new ContentDispositionHeaderValue("form-data")
{
Name = "whatsapp_user_id",
}
}
},
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_media");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001");
request.AddParameter("multipart/form-data; boundary=---011000010111000001101001", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_media"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/whatsapp_media HTTP/1.1
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Host: example.com
Content-Length: 306
-----011000010111000001101001
Content-Disposition: form-data; name="media_content_type"
-----011000010111000001101001
Content-Disposition: form-data; name="upload_file"
-----011000010111000001101001
Content-Disposition: form-data; name="whatsapp_user_id"
-----011000010111000001101001--
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/whatsapp_media")
.setHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.setBody("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_media"))
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.method("POST", HttpRequest.BodyPublishers.ofString("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_media")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/whatsapp_media")
.header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
.asString();
const data = new FormData();
data.append('media_content_type', '');
data.append('upload_file', '');
data.append('whatsapp_user_id', '');
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/whatsapp_media');
xhr.send(data);
import axios from 'axios';
const form = new FormData();
form.append('media_content_type', '');
form.append('upload_file', '');
form.append('whatsapp_user_id', '');
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_media',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '[form]'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_media';
const form = new FormData();
form.append('media_content_type', '');
form.append('upload_file', '');
form.append('whatsapp_user_id', '');
const options = {method: 'POST'};
options.body = form;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const form = new FormData();
form.append('media_content_type', '');
form.append('upload_file', '');
form.append('whatsapp_user_id', '');
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_media',
method: 'POST',
headers: {},
processData: false,
contentType: false,
mimeType: 'multipart/form-data',
data: form
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001")
val body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_media")
.post(body)
.addHeader("content-type", "multipart/form-data; boundary=---011000010111000001101001")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_media',
headers: {
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write('-----011000010111000001101001\r\nContent-Disposition: form-data; name="media_content_type"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="upload_file"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="whatsapp_user_id"\r\n\r\n\r\n-----011000010111000001101001--\r\n');
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_media',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
formData: {media_content_type: '', upload_file: '', whatsapp_user_id: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/whatsapp_media');
req.headers({
'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
});
req.multipart([]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_media',
headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
data: '-----011000010111000001101001\r\nContent-Disposition: form-data; name="media_content_type"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="upload_file"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="whatsapp_user_id"\r\n\r\n\r\n-----011000010111000001101001--\r\n'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();
formData.append('media_content_type', '');
formData.append('upload_file', '');
formData.append('whatsapp_user_id', '');
const url = '{{baseUrl}}/whatsapp_media';
const options = {method: 'POST'};
options.body = formData;
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"multipart/form-data; boundary=---011000010111000001101001" };
NSArray *parameters = @[ @{ @"name": @"media_content_type", @"value": @"" },
@{ @"name": @"upload_file", @"value": @"" },
@{ @"name": @"whatsapp_user_id", @"value": @"" } ];
NSString *boundary = @"---011000010111000001101001";
NSError *error;
NSMutableString *body = [NSMutableString string];
for (NSDictionary *param in parameters) {
[body appendFormat:@"--%@\r\n", boundary];
if (param[@"fileName"]) {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"; filename=\"%@\"\r\n", param[@"name"], param[@"fileName"]];
[body appendFormat:@"Content-Type: %@\r\n\r\n", param[@"contentType"]];
[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];
if (error) {
NSLog(@"%@", error);
}
} else {
[body appendFormat:@"Content-Disposition:form-data; name=\"%@\"\r\n\r\n", param[@"name"]];
[body appendFormat:@"%@", param[@"value"]];
}
}
[body appendFormat:@"\r\n--%@--\r\n", boundary];
NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_media"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_media" in
let headers = Header.add (Header.init ()) "content-type" "multipart/form-data; boundary=---011000010111000001101001" in
let body = Cohttp_lwt_body.of_string "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_media",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n",
CURLOPT_HTTPHEADER => [
"content-type: multipart/form-data; boundary=---011000010111000001101001"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/whatsapp_media', [
'headers' => [
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_media');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'multipart/form-data; boundary=---011000010111000001101001'
]);
$request->setBody('-----011000010111000001101001
Content-Disposition: form-data; name="media_content_type"
-----011000010111000001101001
Content-Disposition: form-data; name="upload_file"
-----011000010111000001101001
Content-Disposition: form-data; name="whatsapp_user_id"
-----011000010111000001101001--
');
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
addForm(null, null);
$request->setRequestUrl('{{baseUrl}}/whatsapp_media');
$request->setRequestMethod('POST');
$request->setBody($body);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_media' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="media_content_type"
-----011000010111000001101001
Content-Disposition: form-data; name="upload_file"
-----011000010111000001101001
Content-Disposition: form-data; name="whatsapp_user_id"
-----011000010111000001101001--
'
$headers=@{}
$headers.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_media' -Method POST -Headers $headers -ContentType 'multipart/form-data; boundary=---011000010111000001101001' -Body '-----011000010111000001101001
Content-Disposition: form-data; name="media_content_type"
-----011000010111000001101001
Content-Disposition: form-data; name="upload_file"
-----011000010111000001101001
Content-Disposition: form-data; name="whatsapp_user_id"
-----011000010111000001101001--
'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = { 'content-type': "multipart/form-data; boundary=---011000010111000001101001" }
conn.request("POST", "/baseUrl/whatsapp_media", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_media"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {"content-type": "multipart/form-data; boundary=---011000010111000001101001"}
response = requests.post(url, data=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_media"
payload <- "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
encode <- "multipart"
response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_media")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001'}
)
response = conn.post('/baseUrl/whatsapp_media') do |req|
req.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"media_content_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload_file\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"whatsapp_user_id\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_media";
let form = reqwest::multipart::Form::new()
.text("media_content_type", "")
.text("upload_file", "")
.text("whatsapp_user_id", "");
let mut headers = reqwest::header::HeaderMap::new();
let client = reqwest::Client::new();
let response = client.post(url)
.multipart(form)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/whatsapp_media \
--header 'content-type: multipart/form-data' \
--form media_content_type= \
--form upload_file= \
--form whatsapp_user_id=
echo '-----011000010111000001101001
Content-Disposition: form-data; name="media_content_type"
-----011000010111000001101001
Content-Disposition: form-data; name="upload_file"
-----011000010111000001101001
Content-Disposition: form-data; name="whatsapp_user_id"
-----011000010111000001101001--
' | \
http POST {{baseUrl}}/whatsapp_media \
content-type:'multipart/form-data; boundary=---011000010111000001101001'
wget --quiet \
--method POST \
--header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
--body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="media_content_type"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="upload_file"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="whatsapp_user_id"\r\n\r\n\r\n-----011000010111000001101001--\r\n' \
--output-document \
- {{baseUrl}}/whatsapp_media
import Foundation
let headers = ["content-type": "multipart/form-data; boundary=---011000010111000001101001"]
let parameters = [
[
"name": "media_content_type",
"value": ""
],
[
"name": "upload_file",
"value": ""
],
[
"name": "whatsapp_user_id",
"value": ""
]
]
let boundary = "---011000010111000001101001"
var body = ""
var error: NSError? = nil
for param in parameters {
let paramName = param["name"]!
body += "--\(boundary)\r\n"
body += "Content-Disposition:form-data; name=\"\(paramName)\""
if let filename = param["fileName"] {
let contentType = param["content-type"]!
let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
if (error != nil) {
print(error as Any)
}
body += "; filename=\"\(filename)\"\r\n"
body += "Content-Type: \(contentType)\r\n\r\n"
body += fileContent
} else if let paramValue = param["value"] {
body += "\r\n\r\n\(paramValue)"
}
}
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_media")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"id": "f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68",
"record_type": "whatsapp_media_id"
}
]
}
PATCH
Mark Message As Read
{{baseUrl}}/whatsapp_messages/:message_id
QUERY PARAMS
message_id
BODY json
{
"status": "",
"whatsapp_user_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_messages/:message_id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/whatsapp_messages/:message_id" {:content-type :json
:form-params {:status "read"
:whatsapp_user_id "15125551212"}})
require "http/client"
url = "{{baseUrl}}/whatsapp_messages/:message_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/whatsapp_messages/:message_id"),
Content = new StringContent("{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_messages/:message_id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_messages/:message_id"
payload := strings.NewReader("{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/whatsapp_messages/:message_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 59
{
"status": "read",
"whatsapp_user_id": "15125551212"
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/whatsapp_messages/:message_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_messages/:message_id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_messages/:message_id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/whatsapp_messages/:message_id")
.header("content-type", "application/json")
.body("{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}")
.asString();
const data = JSON.stringify({
status: 'read',
whatsapp_user_id: '15125551212'
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/whatsapp_messages/:message_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/whatsapp_messages/:message_id',
headers: {'content-type': 'application/json'},
data: {status: 'read', whatsapp_user_id: '15125551212'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_messages/:message_id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"status":"read","whatsapp_user_id":"15125551212"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_messages/:message_id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "status": "read",\n "whatsapp_user_id": "15125551212"\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_messages/:message_id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_messages/:message_id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({status: 'read', whatsapp_user_id: '15125551212'}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/whatsapp_messages/:message_id',
headers: {'content-type': 'application/json'},
body: {status: 'read', whatsapp_user_id: '15125551212'},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/whatsapp_messages/:message_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
status: 'read',
whatsapp_user_id: '15125551212'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/whatsapp_messages/:message_id',
headers: {'content-type': 'application/json'},
data: {status: 'read', whatsapp_user_id: '15125551212'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_messages/:message_id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"status":"read","whatsapp_user_id":"15125551212"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"status": @"read",
@"whatsapp_user_id": @"15125551212" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_messages/:message_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_messages/:message_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_messages/:message_id",
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([
'status' => 'read',
'whatsapp_user_id' => '15125551212'
]),
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;
}
request('PATCH', '{{baseUrl}}/whatsapp_messages/:message_id', [
'body' => '{
"status": "read",
"whatsapp_user_id": "15125551212"
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_messages/:message_id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'status' => 'read',
'whatsapp_user_id' => '15125551212'
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'status' => 'read',
'whatsapp_user_id' => '15125551212'
]));
$request->setRequestUrl('{{baseUrl}}/whatsapp_messages/:message_id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_messages/:message_id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"status": "read",
"whatsapp_user_id": "15125551212"
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_messages/:message_id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"status": "read",
"whatsapp_user_id": "15125551212"
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/whatsapp_messages/:message_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_messages/:message_id"
payload = {
"status": "read",
"whatsapp_user_id": "15125551212"
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_messages/:message_id"
payload <- "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_messages/:message_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/whatsapp_messages/:message_id') do |req|
req.body = "{\n \"status\": \"read\",\n \"whatsapp_user_id\": \"15125551212\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_messages/:message_id";
let payload = json!({
"status": "read",
"whatsapp_user_id": "15125551212"
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/whatsapp_messages/:message_id \
--header 'content-type: application/json' \
--data '{
"status": "read",
"whatsapp_user_id": "15125551212"
}'
echo '{
"status": "read",
"whatsapp_user_id": "15125551212"
}' | \
http PATCH {{baseUrl}}/whatsapp_messages/:message_id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "status": "read",\n "whatsapp_user_id": "15125551212"\n}' \
--output-document \
- {{baseUrl}}/whatsapp_messages/:message_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"status": "read",
"whatsapp_user_id": "15125551212"
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_messages/:message_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Send Message
{{baseUrl}}/whatsapp_messages
BODY json
{
"audio": {
"id": "",
"link": ""
},
"contacts": [
{
"addresses": [
{
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
}
],
"birthday": "",
"emails": [
{
"email": "",
"type": ""
}
],
"ims": [],
"name": {
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"id": "",
"phone": "",
"type": ""
}
],
"urls": [
{
"type": "",
"url": ""
}
]
}
],
"document": {
"caption": "",
"filename": "",
"id": "",
"link": ""
},
"hsm": {
"element_name": "",
"language": {
"code": "",
"policy": ""
},
"localizable_params": [
{
"currency": {
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
},
"date_time": {
"component": {
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
},
"unix_epoch": {
"timestamp": 0
}
},
"default": ""
}
],
"namespace": ""
},
"image": {
"caption": "",
"id": "",
"link": ""
},
"location": {
"address": "",
"latitude": "",
"longitude": "",
"name": ""
},
"preview_url": false,
"template": {
"components": [
{
"parameters": [
{
"currency": {},
"date_time": {},
"document": {},
"image": {},
"text": "",
"type": "",
"video": {
"caption": "",
"id": "",
"link": ""
}
}
],
"type": ""
}
],
"language": {},
"name": "",
"namespace": ""
},
"text": {
"body": ""
},
"to": "",
"type": "",
"video": {},
"whatsapp_user_id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_messages");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/whatsapp_messages" {:content-type :json
:form-params {:audio {:id ""
:link ""}
:contacts [{:addresses [{:city ""
:country ""
:country_code ""
:state ""
:street ""
:type ""
:zip ""}]
:birthday ""
:emails [{:email ""
:type ""}]
:ims []
:name {:first_name ""
:formatted_name ""
:last_name ""
:prefix ""
:suffix ""}
:org {:company ""
:department ""
:title ""}
:phones [{:id ""
:phone ""
:type ""}]
:urls [{:type ""
:url ""}]}]
:document {:caption ""
:filename ""
:id ""
:link ""}
:hsm {:element_name ""
:language {:code ""
:policy ""}
:localizable_params [{:currency {:amount_1000 0
:currency_code ""
:fallback_value ""}
:date_time {:component {:day_of_month 0
:day_of_week 0
:hour 0
:minute 0
:month 0
:year 0}
:unix_epoch {:timestamp 0}}
:default ""}]
:namespace ""}
:image {:caption ""
:id ""
:link ""}
:location {:address ""
:latitude ""
:longitude ""
:name ""}
:preview_url false
:template {:components [{:parameters [{:currency {}
:date_time {}
:document {}
:image {}
:text ""
:type ""
:video {:caption ""
:id ""
:link ""}}]
:type ""}]
:language {}
:name ""
:namespace ""}
:text {:body ""}
:to ""
:type ""
:video {}
:whatsapp_user_id ""}})
require "http/client"
url = "{{baseUrl}}/whatsapp_messages"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/whatsapp_messages"),
Content = new StringContent("{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_messages");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_messages"
payload := strings.NewReader("{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\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(res)
fmt.Println(string(body))
}
POST /baseUrl/whatsapp_messages HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2322
{
"audio": {
"id": "",
"link": ""
},
"contacts": [
{
"addresses": [
{
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
}
],
"birthday": "",
"emails": [
{
"email": "",
"type": ""
}
],
"ims": [],
"name": {
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"id": "",
"phone": "",
"type": ""
}
],
"urls": [
{
"type": "",
"url": ""
}
]
}
],
"document": {
"caption": "",
"filename": "",
"id": "",
"link": ""
},
"hsm": {
"element_name": "",
"language": {
"code": "",
"policy": ""
},
"localizable_params": [
{
"currency": {
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
},
"date_time": {
"component": {
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
},
"unix_epoch": {
"timestamp": 0
}
},
"default": ""
}
],
"namespace": ""
},
"image": {
"caption": "",
"id": "",
"link": ""
},
"location": {
"address": "",
"latitude": "",
"longitude": "",
"name": ""
},
"preview_url": false,
"template": {
"components": [
{
"parameters": [
{
"currency": {},
"date_time": {},
"document": {},
"image": {},
"text": "",
"type": "",
"video": {
"caption": "",
"id": "",
"link": ""
}
}
],
"type": ""
}
],
"language": {},
"name": "",
"namespace": ""
},
"text": {
"body": ""
},
"to": "",
"type": "",
"video": {},
"whatsapp_user_id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/whatsapp_messages")
.setHeader("content-type", "application/json")
.setBody("{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_messages"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_messages")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/whatsapp_messages")
.header("content-type", "application/json")
.body("{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}")
.asString();
const data = JSON.stringify({
audio: {
id: '',
link: ''
},
contacts: [
{
addresses: [
{
city: '',
country: '',
country_code: '',
state: '',
street: '',
type: '',
zip: ''
}
],
birthday: '',
emails: [
{
email: '',
type: ''
}
],
ims: [],
name: {
first_name: '',
formatted_name: '',
last_name: '',
prefix: '',
suffix: ''
},
org: {
company: '',
department: '',
title: ''
},
phones: [
{
id: '',
phone: '',
type: ''
}
],
urls: [
{
type: '',
url: ''
}
]
}
],
document: {
caption: '',
filename: '',
id: '',
link: ''
},
hsm: {
element_name: '',
language: {
code: '',
policy: ''
},
localizable_params: [
{
currency: {
amount_1000: 0,
currency_code: '',
fallback_value: ''
},
date_time: {
component: {
day_of_month: 0,
day_of_week: 0,
hour: 0,
minute: 0,
month: 0,
year: 0
},
unix_epoch: {
timestamp: 0
}
},
default: ''
}
],
namespace: ''
},
image: {
caption: '',
id: '',
link: ''
},
location: {
address: '',
latitude: '',
longitude: '',
name: ''
},
preview_url: false,
template: {
components: [
{
parameters: [
{
currency: {},
date_time: {},
document: {},
image: {},
text: '',
type: '',
video: {
caption: '',
id: '',
link: ''
}
}
],
type: ''
}
],
language: {},
name: '',
namespace: ''
},
text: {
body: ''
},
to: '',
type: '',
video: {},
whatsapp_user_id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/whatsapp_messages');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_messages',
headers: {'content-type': 'application/json'},
data: {
audio: {id: '', link: ''},
contacts: [
{
addresses: [
{
city: '',
country: '',
country_code: '',
state: '',
street: '',
type: '',
zip: ''
}
],
birthday: '',
emails: [{email: '', type: ''}],
ims: [],
name: {first_name: '', formatted_name: '', last_name: '', prefix: '', suffix: ''},
org: {company: '', department: '', title: ''},
phones: [{id: '', phone: '', type: ''}],
urls: [{type: '', url: ''}]
}
],
document: {caption: '', filename: '', id: '', link: ''},
hsm: {
element_name: '',
language: {code: '', policy: ''},
localizable_params: [
{
currency: {amount_1000: 0, currency_code: '', fallback_value: ''},
date_time: {
component: {day_of_month: 0, day_of_week: 0, hour: 0, minute: 0, month: 0, year: 0},
unix_epoch: {timestamp: 0}
},
default: ''
}
],
namespace: ''
},
image: {caption: '', id: '', link: ''},
location: {address: '', latitude: '', longitude: '', name: ''},
preview_url: false,
template: {
components: [
{
parameters: [
{
currency: {},
date_time: {},
document: {},
image: {},
text: '',
type: '',
video: {caption: '', id: '', link: ''}
}
],
type: ''
}
],
language: {},
name: '',
namespace: ''
},
text: {body: ''},
to: '',
type: '',
video: {},
whatsapp_user_id: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_messages';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio":{"id":"","link":""},"contacts":[{"addresses":[{"city":"","country":"","country_code":"","state":"","street":"","type":"","zip":""}],"birthday":"","emails":[{"email":"","type":""}],"ims":[],"name":{"first_name":"","formatted_name":"","last_name":"","prefix":"","suffix":""},"org":{"company":"","department":"","title":""},"phones":[{"id":"","phone":"","type":""}],"urls":[{"type":"","url":""}]}],"document":{"caption":"","filename":"","id":"","link":""},"hsm":{"element_name":"","language":{"code":"","policy":""},"localizable_params":[{"currency":{"amount_1000":0,"currency_code":"","fallback_value":""},"date_time":{"component":{"day_of_month":0,"day_of_week":0,"hour":0,"minute":0,"month":0,"year":0},"unix_epoch":{"timestamp":0}},"default":""}],"namespace":""},"image":{"caption":"","id":"","link":""},"location":{"address":"","latitude":"","longitude":"","name":""},"preview_url":false,"template":{"components":[{"parameters":[{"currency":{},"date_time":{},"document":{},"image":{},"text":"","type":"","video":{"caption":"","id":"","link":""}}],"type":""}],"language":{},"name":"","namespace":""},"text":{"body":""},"to":"","type":"","video":{},"whatsapp_user_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_messages',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "audio": {\n "id": "",\n "link": ""\n },\n "contacts": [\n {\n "addresses": [\n {\n "city": "",\n "country": "",\n "country_code": "",\n "state": "",\n "street": "",\n "type": "",\n "zip": ""\n }\n ],\n "birthday": "",\n "emails": [\n {\n "email": "",\n "type": ""\n }\n ],\n "ims": [],\n "name": {\n "first_name": "",\n "formatted_name": "",\n "last_name": "",\n "prefix": "",\n "suffix": ""\n },\n "org": {\n "company": "",\n "department": "",\n "title": ""\n },\n "phones": [\n {\n "id": "",\n "phone": "",\n "type": ""\n }\n ],\n "urls": [\n {\n "type": "",\n "url": ""\n }\n ]\n }\n ],\n "document": {\n "caption": "",\n "filename": "",\n "id": "",\n "link": ""\n },\n "hsm": {\n "element_name": "",\n "language": {\n "code": "",\n "policy": ""\n },\n "localizable_params": [\n {\n "currency": {\n "amount_1000": 0,\n "currency_code": "",\n "fallback_value": ""\n },\n "date_time": {\n "component": {\n "day_of_month": 0,\n "day_of_week": 0,\n "hour": 0,\n "minute": 0,\n "month": 0,\n "year": 0\n },\n "unix_epoch": {\n "timestamp": 0\n }\n },\n "default": ""\n }\n ],\n "namespace": ""\n },\n "image": {\n "caption": "",\n "id": "",\n "link": ""\n },\n "location": {\n "address": "",\n "latitude": "",\n "longitude": "",\n "name": ""\n },\n "preview_url": false,\n "template": {\n "components": [\n {\n "parameters": [\n {\n "currency": {},\n "date_time": {},\n "document": {},\n "image": {},\n "text": "",\n "type": "",\n "video": {\n "caption": "",\n "id": "",\n "link": ""\n }\n }\n ],\n "type": ""\n }\n ],\n "language": {},\n "name": "",\n "namespace": ""\n },\n "text": {\n "body": ""\n },\n "to": "",\n "type": "",\n "video": {},\n "whatsapp_user_id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_messages")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_messages',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
audio: {id: '', link: ''},
contacts: [
{
addresses: [
{
city: '',
country: '',
country_code: '',
state: '',
street: '',
type: '',
zip: ''
}
],
birthday: '',
emails: [{email: '', type: ''}],
ims: [],
name: {first_name: '', formatted_name: '', last_name: '', prefix: '', suffix: ''},
org: {company: '', department: '', title: ''},
phones: [{id: '', phone: '', type: ''}],
urls: [{type: '', url: ''}]
}
],
document: {caption: '', filename: '', id: '', link: ''},
hsm: {
element_name: '',
language: {code: '', policy: ''},
localizable_params: [
{
currency: {amount_1000: 0, currency_code: '', fallback_value: ''},
date_time: {
component: {day_of_month: 0, day_of_week: 0, hour: 0, minute: 0, month: 0, year: 0},
unix_epoch: {timestamp: 0}
},
default: ''
}
],
namespace: ''
},
image: {caption: '', id: '', link: ''},
location: {address: '', latitude: '', longitude: '', name: ''},
preview_url: false,
template: {
components: [
{
parameters: [
{
currency: {},
date_time: {},
document: {},
image: {},
text: '',
type: '',
video: {caption: '', id: '', link: ''}
}
],
type: ''
}
],
language: {},
name: '',
namespace: ''
},
text: {body: ''},
to: '',
type: '',
video: {},
whatsapp_user_id: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_messages',
headers: {'content-type': 'application/json'},
body: {
audio: {id: '', link: ''},
contacts: [
{
addresses: [
{
city: '',
country: '',
country_code: '',
state: '',
street: '',
type: '',
zip: ''
}
],
birthday: '',
emails: [{email: '', type: ''}],
ims: [],
name: {first_name: '', formatted_name: '', last_name: '', prefix: '', suffix: ''},
org: {company: '', department: '', title: ''},
phones: [{id: '', phone: '', type: ''}],
urls: [{type: '', url: ''}]
}
],
document: {caption: '', filename: '', id: '', link: ''},
hsm: {
element_name: '',
language: {code: '', policy: ''},
localizable_params: [
{
currency: {amount_1000: 0, currency_code: '', fallback_value: ''},
date_time: {
component: {day_of_month: 0, day_of_week: 0, hour: 0, minute: 0, month: 0, year: 0},
unix_epoch: {timestamp: 0}
},
default: ''
}
],
namespace: ''
},
image: {caption: '', id: '', link: ''},
location: {address: '', latitude: '', longitude: '', name: ''},
preview_url: false,
template: {
components: [
{
parameters: [
{
currency: {},
date_time: {},
document: {},
image: {},
text: '',
type: '',
video: {caption: '', id: '', link: ''}
}
],
type: ''
}
],
language: {},
name: '',
namespace: ''
},
text: {body: ''},
to: '',
type: '',
video: {},
whatsapp_user_id: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/whatsapp_messages');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
audio: {
id: '',
link: ''
},
contacts: [
{
addresses: [
{
city: '',
country: '',
country_code: '',
state: '',
street: '',
type: '',
zip: ''
}
],
birthday: '',
emails: [
{
email: '',
type: ''
}
],
ims: [],
name: {
first_name: '',
formatted_name: '',
last_name: '',
prefix: '',
suffix: ''
},
org: {
company: '',
department: '',
title: ''
},
phones: [
{
id: '',
phone: '',
type: ''
}
],
urls: [
{
type: '',
url: ''
}
]
}
],
document: {
caption: '',
filename: '',
id: '',
link: ''
},
hsm: {
element_name: '',
language: {
code: '',
policy: ''
},
localizable_params: [
{
currency: {
amount_1000: 0,
currency_code: '',
fallback_value: ''
},
date_time: {
component: {
day_of_month: 0,
day_of_week: 0,
hour: 0,
minute: 0,
month: 0,
year: 0
},
unix_epoch: {
timestamp: 0
}
},
default: ''
}
],
namespace: ''
},
image: {
caption: '',
id: '',
link: ''
},
location: {
address: '',
latitude: '',
longitude: '',
name: ''
},
preview_url: false,
template: {
components: [
{
parameters: [
{
currency: {},
date_time: {},
document: {},
image: {},
text: '',
type: '',
video: {
caption: '',
id: '',
link: ''
}
}
],
type: ''
}
],
language: {},
name: '',
namespace: ''
},
text: {
body: ''
},
to: '',
type: '',
video: {},
whatsapp_user_id: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/whatsapp_messages',
headers: {'content-type': 'application/json'},
data: {
audio: {id: '', link: ''},
contacts: [
{
addresses: [
{
city: '',
country: '',
country_code: '',
state: '',
street: '',
type: '',
zip: ''
}
],
birthday: '',
emails: [{email: '', type: ''}],
ims: [],
name: {first_name: '', formatted_name: '', last_name: '', prefix: '', suffix: ''},
org: {company: '', department: '', title: ''},
phones: [{id: '', phone: '', type: ''}],
urls: [{type: '', url: ''}]
}
],
document: {caption: '', filename: '', id: '', link: ''},
hsm: {
element_name: '',
language: {code: '', policy: ''},
localizable_params: [
{
currency: {amount_1000: 0, currency_code: '', fallback_value: ''},
date_time: {
component: {day_of_month: 0, day_of_week: 0, hour: 0, minute: 0, month: 0, year: 0},
unix_epoch: {timestamp: 0}
},
default: ''
}
],
namespace: ''
},
image: {caption: '', id: '', link: ''},
location: {address: '', latitude: '', longitude: '', name: ''},
preview_url: false,
template: {
components: [
{
parameters: [
{
currency: {},
date_time: {},
document: {},
image: {},
text: '',
type: '',
video: {caption: '', id: '', link: ''}
}
],
type: ''
}
],
language: {},
name: '',
namespace: ''
},
text: {body: ''},
to: '',
type: '',
video: {},
whatsapp_user_id: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_messages';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"audio":{"id":"","link":""},"contacts":[{"addresses":[{"city":"","country":"","country_code":"","state":"","street":"","type":"","zip":""}],"birthday":"","emails":[{"email":"","type":""}],"ims":[],"name":{"first_name":"","formatted_name":"","last_name":"","prefix":"","suffix":""},"org":{"company":"","department":"","title":""},"phones":[{"id":"","phone":"","type":""}],"urls":[{"type":"","url":""}]}],"document":{"caption":"","filename":"","id":"","link":""},"hsm":{"element_name":"","language":{"code":"","policy":""},"localizable_params":[{"currency":{"amount_1000":0,"currency_code":"","fallback_value":""},"date_time":{"component":{"day_of_month":0,"day_of_week":0,"hour":0,"minute":0,"month":0,"year":0},"unix_epoch":{"timestamp":0}},"default":""}],"namespace":""},"image":{"caption":"","id":"","link":""},"location":{"address":"","latitude":"","longitude":"","name":""},"preview_url":false,"template":{"components":[{"parameters":[{"currency":{},"date_time":{},"document":{},"image":{},"text":"","type":"","video":{"caption":"","id":"","link":""}}],"type":""}],"language":{},"name":"","namespace":""},"text":{"body":""},"to":"","type":"","video":{},"whatsapp_user_id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"audio": @{ @"id": @"", @"link": @"" },
@"contacts": @[ @{ @"addresses": @[ @{ @"city": @"", @"country": @"", @"country_code": @"", @"state": @"", @"street": @"", @"type": @"", @"zip": @"" } ], @"birthday": @"", @"emails": @[ @{ @"email": @"", @"type": @"" } ], @"ims": @[ ], @"name": @{ @"first_name": @"", @"formatted_name": @"", @"last_name": @"", @"prefix": @"", @"suffix": @"" }, @"org": @{ @"company": @"", @"department": @"", @"title": @"" }, @"phones": @[ @{ @"id": @"", @"phone": @"", @"type": @"" } ], @"urls": @[ @{ @"type": @"", @"url": @"" } ] } ],
@"document": @{ @"caption": @"", @"filename": @"", @"id": @"", @"link": @"" },
@"hsm": @{ @"element_name": @"", @"language": @{ @"code": @"", @"policy": @"" }, @"localizable_params": @[ @{ @"currency": @{ @"amount_1000": @0, @"currency_code": @"", @"fallback_value": @"" }, @"date_time": @{ @"component": @{ @"day_of_month": @0, @"day_of_week": @0, @"hour": @0, @"minute": @0, @"month": @0, @"year": @0 }, @"unix_epoch": @{ @"timestamp": @0 } }, @"default": @"" } ], @"namespace": @"" },
@"image": @{ @"caption": @"", @"id": @"", @"link": @"" },
@"location": @{ @"address": @"", @"latitude": @"", @"longitude": @"", @"name": @"" },
@"preview_url": @NO,
@"template": @{ @"components": @[ @{ @"parameters": @[ @{ @"currency": @{ }, @"date_time": @{ }, @"document": @{ }, @"image": @{ }, @"text": @"", @"type": @"", @"video": @{ @"caption": @"", @"id": @"", @"link": @"" } } ], @"type": @"" } ], @"language": @{ }, @"name": @"", @"namespace": @"" },
@"text": @{ @"body": @"" },
@"to": @"",
@"type": @"",
@"video": @{ },
@"whatsapp_user_id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_messages"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_messages" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_messages",
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([
'audio' => [
'id' => '',
'link' => ''
],
'contacts' => [
[
'addresses' => [
[
'city' => '',
'country' => '',
'country_code' => '',
'state' => '',
'street' => '',
'type' => '',
'zip' => ''
]
],
'birthday' => '',
'emails' => [
[
'email' => '',
'type' => ''
]
],
'ims' => [
],
'name' => [
'first_name' => '',
'formatted_name' => '',
'last_name' => '',
'prefix' => '',
'suffix' => ''
],
'org' => [
'company' => '',
'department' => '',
'title' => ''
],
'phones' => [
[
'id' => '',
'phone' => '',
'type' => ''
]
],
'urls' => [
[
'type' => '',
'url' => ''
]
]
]
],
'document' => [
'caption' => '',
'filename' => '',
'id' => '',
'link' => ''
],
'hsm' => [
'element_name' => '',
'language' => [
'code' => '',
'policy' => ''
],
'localizable_params' => [
[
'currency' => [
'amount_1000' => 0,
'currency_code' => '',
'fallback_value' => ''
],
'date_time' => [
'component' => [
'day_of_month' => 0,
'day_of_week' => 0,
'hour' => 0,
'minute' => 0,
'month' => 0,
'year' => 0
],
'unix_epoch' => [
'timestamp' => 0
]
],
'default' => ''
]
],
'namespace' => ''
],
'image' => [
'caption' => '',
'id' => '',
'link' => ''
],
'location' => [
'address' => '',
'latitude' => '',
'longitude' => '',
'name' => ''
],
'preview_url' => null,
'template' => [
'components' => [
[
'parameters' => [
[
'currency' => [
],
'date_time' => [
],
'document' => [
],
'image' => [
],
'text' => '',
'type' => '',
'video' => [
'caption' => '',
'id' => '',
'link' => ''
]
]
],
'type' => ''
]
],
'language' => [
],
'name' => '',
'namespace' => ''
],
'text' => [
'body' => ''
],
'to' => '',
'type' => '',
'video' => [
],
'whatsapp_user_id' => ''
]),
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;
}
request('POST', '{{baseUrl}}/whatsapp_messages', [
'body' => '{
"audio": {
"id": "",
"link": ""
},
"contacts": [
{
"addresses": [
{
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
}
],
"birthday": "",
"emails": [
{
"email": "",
"type": ""
}
],
"ims": [],
"name": {
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"id": "",
"phone": "",
"type": ""
}
],
"urls": [
{
"type": "",
"url": ""
}
]
}
],
"document": {
"caption": "",
"filename": "",
"id": "",
"link": ""
},
"hsm": {
"element_name": "",
"language": {
"code": "",
"policy": ""
},
"localizable_params": [
{
"currency": {
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
},
"date_time": {
"component": {
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
},
"unix_epoch": {
"timestamp": 0
}
},
"default": ""
}
],
"namespace": ""
},
"image": {
"caption": "",
"id": "",
"link": ""
},
"location": {
"address": "",
"latitude": "",
"longitude": "",
"name": ""
},
"preview_url": false,
"template": {
"components": [
{
"parameters": [
{
"currency": {},
"date_time": {},
"document": {},
"image": {},
"text": "",
"type": "",
"video": {
"caption": "",
"id": "",
"link": ""
}
}
],
"type": ""
}
],
"language": {},
"name": "",
"namespace": ""
},
"text": {
"body": ""
},
"to": "",
"type": "",
"video": {},
"whatsapp_user_id": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_messages');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'audio' => [
'id' => '',
'link' => ''
],
'contacts' => [
[
'addresses' => [
[
'city' => '',
'country' => '',
'country_code' => '',
'state' => '',
'street' => '',
'type' => '',
'zip' => ''
]
],
'birthday' => '',
'emails' => [
[
'email' => '',
'type' => ''
]
],
'ims' => [
],
'name' => [
'first_name' => '',
'formatted_name' => '',
'last_name' => '',
'prefix' => '',
'suffix' => ''
],
'org' => [
'company' => '',
'department' => '',
'title' => ''
],
'phones' => [
[
'id' => '',
'phone' => '',
'type' => ''
]
],
'urls' => [
[
'type' => '',
'url' => ''
]
]
]
],
'document' => [
'caption' => '',
'filename' => '',
'id' => '',
'link' => ''
],
'hsm' => [
'element_name' => '',
'language' => [
'code' => '',
'policy' => ''
],
'localizable_params' => [
[
'currency' => [
'amount_1000' => 0,
'currency_code' => '',
'fallback_value' => ''
],
'date_time' => [
'component' => [
'day_of_month' => 0,
'day_of_week' => 0,
'hour' => 0,
'minute' => 0,
'month' => 0,
'year' => 0
],
'unix_epoch' => [
'timestamp' => 0
]
],
'default' => ''
]
],
'namespace' => ''
],
'image' => [
'caption' => '',
'id' => '',
'link' => ''
],
'location' => [
'address' => '',
'latitude' => '',
'longitude' => '',
'name' => ''
],
'preview_url' => null,
'template' => [
'components' => [
[
'parameters' => [
[
'currency' => [
],
'date_time' => [
],
'document' => [
],
'image' => [
],
'text' => '',
'type' => '',
'video' => [
'caption' => '',
'id' => '',
'link' => ''
]
]
],
'type' => ''
]
],
'language' => [
],
'name' => '',
'namespace' => ''
],
'text' => [
'body' => ''
],
'to' => '',
'type' => '',
'video' => [
],
'whatsapp_user_id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'audio' => [
'id' => '',
'link' => ''
],
'contacts' => [
[
'addresses' => [
[
'city' => '',
'country' => '',
'country_code' => '',
'state' => '',
'street' => '',
'type' => '',
'zip' => ''
]
],
'birthday' => '',
'emails' => [
[
'email' => '',
'type' => ''
]
],
'ims' => [
],
'name' => [
'first_name' => '',
'formatted_name' => '',
'last_name' => '',
'prefix' => '',
'suffix' => ''
],
'org' => [
'company' => '',
'department' => '',
'title' => ''
],
'phones' => [
[
'id' => '',
'phone' => '',
'type' => ''
]
],
'urls' => [
[
'type' => '',
'url' => ''
]
]
]
],
'document' => [
'caption' => '',
'filename' => '',
'id' => '',
'link' => ''
],
'hsm' => [
'element_name' => '',
'language' => [
'code' => '',
'policy' => ''
],
'localizable_params' => [
[
'currency' => [
'amount_1000' => 0,
'currency_code' => '',
'fallback_value' => ''
],
'date_time' => [
'component' => [
'day_of_month' => 0,
'day_of_week' => 0,
'hour' => 0,
'minute' => 0,
'month' => 0,
'year' => 0
],
'unix_epoch' => [
'timestamp' => 0
]
],
'default' => ''
]
],
'namespace' => ''
],
'image' => [
'caption' => '',
'id' => '',
'link' => ''
],
'location' => [
'address' => '',
'latitude' => '',
'longitude' => '',
'name' => ''
],
'preview_url' => null,
'template' => [
'components' => [
[
'parameters' => [
[
'currency' => [
],
'date_time' => [
],
'document' => [
],
'image' => [
],
'text' => '',
'type' => '',
'video' => [
'caption' => '',
'id' => '',
'link' => ''
]
]
],
'type' => ''
]
],
'language' => [
],
'name' => '',
'namespace' => ''
],
'text' => [
'body' => ''
],
'to' => '',
'type' => '',
'video' => [
],
'whatsapp_user_id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/whatsapp_messages');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_messages' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio": {
"id": "",
"link": ""
},
"contacts": [
{
"addresses": [
{
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
}
],
"birthday": "",
"emails": [
{
"email": "",
"type": ""
}
],
"ims": [],
"name": {
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"id": "",
"phone": "",
"type": ""
}
],
"urls": [
{
"type": "",
"url": ""
}
]
}
],
"document": {
"caption": "",
"filename": "",
"id": "",
"link": ""
},
"hsm": {
"element_name": "",
"language": {
"code": "",
"policy": ""
},
"localizable_params": [
{
"currency": {
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
},
"date_time": {
"component": {
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
},
"unix_epoch": {
"timestamp": 0
}
},
"default": ""
}
],
"namespace": ""
},
"image": {
"caption": "",
"id": "",
"link": ""
},
"location": {
"address": "",
"latitude": "",
"longitude": "",
"name": ""
},
"preview_url": false,
"template": {
"components": [
{
"parameters": [
{
"currency": {},
"date_time": {},
"document": {},
"image": {},
"text": "",
"type": "",
"video": {
"caption": "",
"id": "",
"link": ""
}
}
],
"type": ""
}
],
"language": {},
"name": "",
"namespace": ""
},
"text": {
"body": ""
},
"to": "",
"type": "",
"video": {},
"whatsapp_user_id": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_messages' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"audio": {
"id": "",
"link": ""
},
"contacts": [
{
"addresses": [
{
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
}
],
"birthday": "",
"emails": [
{
"email": "",
"type": ""
}
],
"ims": [],
"name": {
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"id": "",
"phone": "",
"type": ""
}
],
"urls": [
{
"type": "",
"url": ""
}
]
}
],
"document": {
"caption": "",
"filename": "",
"id": "",
"link": ""
},
"hsm": {
"element_name": "",
"language": {
"code": "",
"policy": ""
},
"localizable_params": [
{
"currency": {
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
},
"date_time": {
"component": {
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
},
"unix_epoch": {
"timestamp": 0
}
},
"default": ""
}
],
"namespace": ""
},
"image": {
"caption": "",
"id": "",
"link": ""
},
"location": {
"address": "",
"latitude": "",
"longitude": "",
"name": ""
},
"preview_url": false,
"template": {
"components": [
{
"parameters": [
{
"currency": {},
"date_time": {},
"document": {},
"image": {},
"text": "",
"type": "",
"video": {
"caption": "",
"id": "",
"link": ""
}
}
],
"type": ""
}
],
"language": {},
"name": "",
"namespace": ""
},
"text": {
"body": ""
},
"to": "",
"type": "",
"video": {},
"whatsapp_user_id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/whatsapp_messages", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_messages"
payload = {
"audio": {
"id": "",
"link": ""
},
"contacts": [
{
"addresses": [
{
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
}
],
"birthday": "",
"emails": [
{
"email": "",
"type": ""
}
],
"ims": [],
"name": {
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"id": "",
"phone": "",
"type": ""
}
],
"urls": [
{
"type": "",
"url": ""
}
]
}
],
"document": {
"caption": "",
"filename": "",
"id": "",
"link": ""
},
"hsm": {
"element_name": "",
"language": {
"code": "",
"policy": ""
},
"localizable_params": [
{
"currency": {
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
},
"date_time": {
"component": {
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
},
"unix_epoch": { "timestamp": 0 }
},
"default": ""
}
],
"namespace": ""
},
"image": {
"caption": "",
"id": "",
"link": ""
},
"location": {
"address": "",
"latitude": "",
"longitude": "",
"name": ""
},
"preview_url": False,
"template": {
"components": [
{
"parameters": [
{
"currency": {},
"date_time": {},
"document": {},
"image": {},
"text": "",
"type": "",
"video": {
"caption": "",
"id": "",
"link": ""
}
}
],
"type": ""
}
],
"language": {},
"name": "",
"namespace": ""
},
"text": { "body": "" },
"to": "",
"type": "",
"video": {},
"whatsapp_user_id": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_messages"
payload <- "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_messages")
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 \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/whatsapp_messages') do |req|
req.body = "{\n \"audio\": {\n \"id\": \"\",\n \"link\": \"\"\n },\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"\",\n \"country\": \"\",\n \"country_code\": \"\",\n \"state\": \"\",\n \"street\": \"\",\n \"type\": \"\",\n \"zip\": \"\"\n }\n ],\n \"birthday\": \"\",\n \"emails\": [\n {\n \"email\": \"\",\n \"type\": \"\"\n }\n ],\n \"ims\": [],\n \"name\": {\n \"first_name\": \"\",\n \"formatted_name\": \"\",\n \"last_name\": \"\",\n \"prefix\": \"\",\n \"suffix\": \"\"\n },\n \"org\": {\n \"company\": \"\",\n \"department\": \"\",\n \"title\": \"\"\n },\n \"phones\": [\n {\n \"id\": \"\",\n \"phone\": \"\",\n \"type\": \"\"\n }\n ],\n \"urls\": [\n {\n \"type\": \"\",\n \"url\": \"\"\n }\n ]\n }\n ],\n \"document\": {\n \"caption\": \"\",\n \"filename\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"hsm\": {\n \"element_name\": \"\",\n \"language\": {\n \"code\": \"\",\n \"policy\": \"\"\n },\n \"localizable_params\": [\n {\n \"currency\": {\n \"amount_1000\": 0,\n \"currency_code\": \"\",\n \"fallback_value\": \"\"\n },\n \"date_time\": {\n \"component\": {\n \"day_of_month\": 0,\n \"day_of_week\": 0,\n \"hour\": 0,\n \"minute\": 0,\n \"month\": 0,\n \"year\": 0\n },\n \"unix_epoch\": {\n \"timestamp\": 0\n }\n },\n \"default\": \"\"\n }\n ],\n \"namespace\": \"\"\n },\n \"image\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n },\n \"location\": {\n \"address\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"name\": \"\"\n },\n \"preview_url\": false,\n \"template\": {\n \"components\": [\n {\n \"parameters\": [\n {\n \"currency\": {},\n \"date_time\": {},\n \"document\": {},\n \"image\": {},\n \"text\": \"\",\n \"type\": \"\",\n \"video\": {\n \"caption\": \"\",\n \"id\": \"\",\n \"link\": \"\"\n }\n }\n ],\n \"type\": \"\"\n }\n ],\n \"language\": {},\n \"name\": \"\",\n \"namespace\": \"\"\n },\n \"text\": {\n \"body\": \"\"\n },\n \"to\": \"\",\n \"type\": \"\",\n \"video\": {},\n \"whatsapp_user_id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_messages";
let payload = json!({
"audio": json!({
"id": "",
"link": ""
}),
"contacts": (
json!({
"addresses": (
json!({
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
})
),
"birthday": "",
"emails": (
json!({
"email": "",
"type": ""
})
),
"ims": (),
"name": json!({
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
}),
"org": json!({
"company": "",
"department": "",
"title": ""
}),
"phones": (
json!({
"id": "",
"phone": "",
"type": ""
})
),
"urls": (
json!({
"type": "",
"url": ""
})
)
})
),
"document": json!({
"caption": "",
"filename": "",
"id": "",
"link": ""
}),
"hsm": json!({
"element_name": "",
"language": json!({
"code": "",
"policy": ""
}),
"localizable_params": (
json!({
"currency": json!({
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
}),
"date_time": json!({
"component": json!({
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
}),
"unix_epoch": json!({"timestamp": 0})
}),
"default": ""
})
),
"namespace": ""
}),
"image": json!({
"caption": "",
"id": "",
"link": ""
}),
"location": json!({
"address": "",
"latitude": "",
"longitude": "",
"name": ""
}),
"preview_url": false,
"template": json!({
"components": (
json!({
"parameters": (
json!({
"currency": json!({}),
"date_time": json!({}),
"document": json!({}),
"image": json!({}),
"text": "",
"type": "",
"video": json!({
"caption": "",
"id": "",
"link": ""
})
})
),
"type": ""
})
),
"language": json!({}),
"name": "",
"namespace": ""
}),
"text": json!({"body": ""}),
"to": "",
"type": "",
"video": json!({}),
"whatsapp_user_id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/whatsapp_messages \
--header 'content-type: application/json' \
--data '{
"audio": {
"id": "",
"link": ""
},
"contacts": [
{
"addresses": [
{
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
}
],
"birthday": "",
"emails": [
{
"email": "",
"type": ""
}
],
"ims": [],
"name": {
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"id": "",
"phone": "",
"type": ""
}
],
"urls": [
{
"type": "",
"url": ""
}
]
}
],
"document": {
"caption": "",
"filename": "",
"id": "",
"link": ""
},
"hsm": {
"element_name": "",
"language": {
"code": "",
"policy": ""
},
"localizable_params": [
{
"currency": {
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
},
"date_time": {
"component": {
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
},
"unix_epoch": {
"timestamp": 0
}
},
"default": ""
}
],
"namespace": ""
},
"image": {
"caption": "",
"id": "",
"link": ""
},
"location": {
"address": "",
"latitude": "",
"longitude": "",
"name": ""
},
"preview_url": false,
"template": {
"components": [
{
"parameters": [
{
"currency": {},
"date_time": {},
"document": {},
"image": {},
"text": "",
"type": "",
"video": {
"caption": "",
"id": "",
"link": ""
}
}
],
"type": ""
}
],
"language": {},
"name": "",
"namespace": ""
},
"text": {
"body": ""
},
"to": "",
"type": "",
"video": {},
"whatsapp_user_id": ""
}'
echo '{
"audio": {
"id": "",
"link": ""
},
"contacts": [
{
"addresses": [
{
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
}
],
"birthday": "",
"emails": [
{
"email": "",
"type": ""
}
],
"ims": [],
"name": {
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
},
"org": {
"company": "",
"department": "",
"title": ""
},
"phones": [
{
"id": "",
"phone": "",
"type": ""
}
],
"urls": [
{
"type": "",
"url": ""
}
]
}
],
"document": {
"caption": "",
"filename": "",
"id": "",
"link": ""
},
"hsm": {
"element_name": "",
"language": {
"code": "",
"policy": ""
},
"localizable_params": [
{
"currency": {
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
},
"date_time": {
"component": {
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
},
"unix_epoch": {
"timestamp": 0
}
},
"default": ""
}
],
"namespace": ""
},
"image": {
"caption": "",
"id": "",
"link": ""
},
"location": {
"address": "",
"latitude": "",
"longitude": "",
"name": ""
},
"preview_url": false,
"template": {
"components": [
{
"parameters": [
{
"currency": {},
"date_time": {},
"document": {},
"image": {},
"text": "",
"type": "",
"video": {
"caption": "",
"id": "",
"link": ""
}
}
],
"type": ""
}
],
"language": {},
"name": "",
"namespace": ""
},
"text": {
"body": ""
},
"to": "",
"type": "",
"video": {},
"whatsapp_user_id": ""
}' | \
http POST {{baseUrl}}/whatsapp_messages \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "audio": {\n "id": "",\n "link": ""\n },\n "contacts": [\n {\n "addresses": [\n {\n "city": "",\n "country": "",\n "country_code": "",\n "state": "",\n "street": "",\n "type": "",\n "zip": ""\n }\n ],\n "birthday": "",\n "emails": [\n {\n "email": "",\n "type": ""\n }\n ],\n "ims": [],\n "name": {\n "first_name": "",\n "formatted_name": "",\n "last_name": "",\n "prefix": "",\n "suffix": ""\n },\n "org": {\n "company": "",\n "department": "",\n "title": ""\n },\n "phones": [\n {\n "id": "",\n "phone": "",\n "type": ""\n }\n ],\n "urls": [\n {\n "type": "",\n "url": ""\n }\n ]\n }\n ],\n "document": {\n "caption": "",\n "filename": "",\n "id": "",\n "link": ""\n },\n "hsm": {\n "element_name": "",\n "language": {\n "code": "",\n "policy": ""\n },\n "localizable_params": [\n {\n "currency": {\n "amount_1000": 0,\n "currency_code": "",\n "fallback_value": ""\n },\n "date_time": {\n "component": {\n "day_of_month": 0,\n "day_of_week": 0,\n "hour": 0,\n "minute": 0,\n "month": 0,\n "year": 0\n },\n "unix_epoch": {\n "timestamp": 0\n }\n },\n "default": ""\n }\n ],\n "namespace": ""\n },\n "image": {\n "caption": "",\n "id": "",\n "link": ""\n },\n "location": {\n "address": "",\n "latitude": "",\n "longitude": "",\n "name": ""\n },\n "preview_url": false,\n "template": {\n "components": [\n {\n "parameters": [\n {\n "currency": {},\n "date_time": {},\n "document": {},\n "image": {},\n "text": "",\n "type": "",\n "video": {\n "caption": "",\n "id": "",\n "link": ""\n }\n }\n ],\n "type": ""\n }\n ],\n "language": {},\n "name": "",\n "namespace": ""\n },\n "text": {\n "body": ""\n },\n "to": "",\n "type": "",\n "video": {},\n "whatsapp_user_id": ""\n}' \
--output-document \
- {{baseUrl}}/whatsapp_messages
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"audio": [
"id": "",
"link": ""
],
"contacts": [
[
"addresses": [
[
"city": "",
"country": "",
"country_code": "",
"state": "",
"street": "",
"type": "",
"zip": ""
]
],
"birthday": "",
"emails": [
[
"email": "",
"type": ""
]
],
"ims": [],
"name": [
"first_name": "",
"formatted_name": "",
"last_name": "",
"prefix": "",
"suffix": ""
],
"org": [
"company": "",
"department": "",
"title": ""
],
"phones": [
[
"id": "",
"phone": "",
"type": ""
]
],
"urls": [
[
"type": "",
"url": ""
]
]
]
],
"document": [
"caption": "",
"filename": "",
"id": "",
"link": ""
],
"hsm": [
"element_name": "",
"language": [
"code": "",
"policy": ""
],
"localizable_params": [
[
"currency": [
"amount_1000": 0,
"currency_code": "",
"fallback_value": ""
],
"date_time": [
"component": [
"day_of_month": 0,
"day_of_week": 0,
"hour": 0,
"minute": 0,
"month": 0,
"year": 0
],
"unix_epoch": ["timestamp": 0]
],
"default": ""
]
],
"namespace": ""
],
"image": [
"caption": "",
"id": "",
"link": ""
],
"location": [
"address": "",
"latitude": "",
"longitude": "",
"name": ""
],
"preview_url": false,
"template": [
"components": [
[
"parameters": [
[
"currency": [],
"date_time": [],
"document": [],
"image": [],
"text": "",
"type": "",
"video": [
"caption": "",
"id": "",
"link": ""
]
]
],
"type": ""
]
],
"language": [],
"name": "",
"namespace": ""
],
"text": ["body": ""],
"to": "",
"type": "",
"video": [],
"whatsapp_user_id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_messages")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU",
"record_type": "whatsapp_message_id"
}
}
GET
getUsageAggregationsSync
{{baseUrl}}/whatsapp_usage_aggregations
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_usage_aggregations");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/whatsapp_usage_aggregations")
require "http/client"
url = "{{baseUrl}}/whatsapp_usage_aggregations"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/whatsapp_usage_aggregations"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_usage_aggregations");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_usage_aggregations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/whatsapp_usage_aggregations HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/whatsapp_usage_aggregations")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_usage_aggregations"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_usage_aggregations")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/whatsapp_usage_aggregations")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/whatsapp_usage_aggregations');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/whatsapp_usage_aggregations'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_usage_aggregations';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_usage_aggregations',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_usage_aggregations")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_usage_aggregations',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/whatsapp_usage_aggregations'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/whatsapp_usage_aggregations');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/whatsapp_usage_aggregations'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_usage_aggregations';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_usage_aggregations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_usage_aggregations" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_usage_aggregations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/whatsapp_usage_aggregations');
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_usage_aggregations');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/whatsapp_usage_aggregations');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_usage_aggregations' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_usage_aggregations' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/whatsapp_usage_aggregations")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_usage_aggregations"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_usage_aggregations"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_usage_aggregations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/whatsapp_usage_aggregations') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_usage_aggregations";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/whatsapp_usage_aggregations
http GET {{baseUrl}}/whatsapp_usage_aggregations
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/whatsapp_usage_aggregations
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_usage_aggregations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Get User
{{baseUrl}}/whatsapp_users/:whatsapp_user_id
QUERY PARAMS
whatsapp_user_id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_users/:whatsapp_user_id");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
require "http/client"
url = "{{baseUrl}}/whatsapp_users/:whatsapp_user_id"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/whatsapp_users/:whatsapp_user_id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_users/:whatsapp_user_id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_users/:whatsapp_user_id"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/whatsapp_users/:whatsapp_user_id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_users/:whatsapp_user_id"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
.asString();
const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_users/:whatsapp_user_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_users/:whatsapp_user_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_users/:whatsapp_user_id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_users/:whatsapp_user_id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_users/:whatsapp_user_id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/whatsapp_users/:whatsapp_user_id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_users/:whatsapp_user_id';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_users/:whatsapp_user_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_users/:whatsapp_user_id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_users/:whatsapp_user_id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_users/:whatsapp_user_id' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_users/:whatsapp_user_id' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/whatsapp_users/:whatsapp_user_id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_users/:whatsapp_user_id"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_users/:whatsapp_user_id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/whatsapp_users/:whatsapp_user_id') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_users/:whatsapp_user_id";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/whatsapp_users/:whatsapp_user_id
http GET {{baseUrl}}/whatsapp_users/:whatsapp_user_id
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/whatsapp_users/:whatsapp_user_id
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_users/:whatsapp_user_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"id": "15125551212",
"record_type": "whatsapp_user",
"webhook_url": "https://mywebhook.com/example/endpoint"
}
}
PATCH
Update WhatsApp User
{{baseUrl}}/whatsapp_users/:whatsapp_user_id
QUERY PARAMS
whatsapp_user_id
BODY json
{
"webhook_url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/whatsapp_users/:whatsapp_user_id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/whatsapp_users/:whatsapp_user_id" {:content-type :json
:form-params {:webhook_url "https://mywebhook.com/example/endpoint"}})
require "http/client"
url = "{{baseUrl}}/whatsapp_users/:whatsapp_user_id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/whatsapp_users/:whatsapp_user_id"),
Content = new StringContent("{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/whatsapp_users/:whatsapp_user_id");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/whatsapp_users/:whatsapp_user_id"
payload := strings.NewReader("{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}")
req, _ := http.NewRequest("PATCH", 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(res)
fmt.Println(string(body))
}
PATCH /baseUrl/whatsapp_users/:whatsapp_user_id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 61
{
"webhook_url": "https://mywebhook.com/example/endpoint"
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
.setHeader("content-type", "application/json")
.setBody("{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/whatsapp_users/:whatsapp_user_id"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
.header("content-type", "application/json")
.body("{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}")
.asString();
const data = JSON.stringify({
webhook_url: 'https://mywebhook.com/example/endpoint'
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/whatsapp_users/:whatsapp_user_id',
headers: {'content-type': 'application/json'},
data: {webhook_url: 'https://mywebhook.com/example/endpoint'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/whatsapp_users/:whatsapp_user_id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"webhook_url":"https://mywebhook.com/example/endpoint"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/whatsapp_users/:whatsapp_user_id',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "webhook_url": "https://mywebhook.com/example/endpoint"\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/whatsapp_users/:whatsapp_user_id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({webhook_url: 'https://mywebhook.com/example/endpoint'}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/whatsapp_users/:whatsapp_user_id',
headers: {'content-type': 'application/json'},
body: {webhook_url: 'https://mywebhook.com/example/endpoint'},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
webhook_url: 'https://mywebhook.com/example/endpoint'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/whatsapp_users/:whatsapp_user_id',
headers: {'content-type': 'application/json'},
data: {webhook_url: 'https://mywebhook.com/example/endpoint'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/whatsapp_users/:whatsapp_user_id';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"webhook_url":"https://mywebhook.com/example/endpoint"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"webhook_url": @"https://mywebhook.com/example/endpoint" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/whatsapp_users/:whatsapp_user_id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume];
open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/whatsapp_users/:whatsapp_user_id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/whatsapp_users/:whatsapp_user_id",
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([
'webhook_url' => 'https://mywebhook.com/example/endpoint'
]),
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;
}
request('PATCH', '{{baseUrl}}/whatsapp_users/:whatsapp_user_id', [
'body' => '{
"webhook_url": "https://mywebhook.com/example/endpoint"
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'webhook_url' => 'https://mywebhook.com/example/endpoint'
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'webhook_url' => 'https://mywebhook.com/example/endpoint'
]));
$request->setRequestUrl('{{baseUrl}}/whatsapp_users/:whatsapp_user_id');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/whatsapp_users/:whatsapp_user_id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"webhook_url": "https://mywebhook.com/example/endpoint"
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/whatsapp_users/:whatsapp_user_id' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"webhook_url": "https://mywebhook.com/example/endpoint"
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/whatsapp_users/:whatsapp_user_id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/whatsapp_users/:whatsapp_user_id"
payload = { "webhook_url": "https://mywebhook.com/example/endpoint" }
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/whatsapp_users/:whatsapp_user_id"
payload <- "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/whatsapp_users/:whatsapp_user_id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/whatsapp_users/:whatsapp_user_id') do |req|
req.body = "{\n \"webhook_url\": \"https://mywebhook.com/example/endpoint\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/whatsapp_users/:whatsapp_user_id";
let payload = json!({"webhook_url": "https://mywebhook.com/example/endpoint"});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/whatsapp_users/:whatsapp_user_id \
--header 'content-type: application/json' \
--data '{
"webhook_url": "https://mywebhook.com/example/endpoint"
}'
echo '{
"webhook_url": "https://mywebhook.com/example/endpoint"
}' | \
http PATCH {{baseUrl}}/whatsapp_users/:whatsapp_user_id \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "webhook_url": "https://mywebhook.com/example/endpoint"\n}' \
--output-document \
- {{baseUrl}}/whatsapp_users/:whatsapp_user_id
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["webhook_url": "https://mywebhook.com/example/endpoint"] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/whatsapp_users/:whatsapp_user_id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()