BulkSMS JSON REST API
BulkSMS JSON REST APIv1.0.0
Overview The JSON REST API allows you to submit and receive BulkSMS messages. You can also get access to past messages and see your account profile. The base URL to use for this service is https://api.bulksms.com/v1. The base URL cannot be used on its own; you must append a path that identifies an operation and you may have to specify some path parameters as well. Click here to go to the main BulkSMS developer site. In order to give you an idea on how the API can be used, some JSON snippets are provided below. Have a look at the messages section for more information. Probably the most simple…
- Endpoints
- 15 (8 GET, 6 POST, 1 DELETE)
- Base URL
https://api.bulksms.com/v1- Authentication
- Basic auth
- Spec format
- OpenAPI 3.0.0
- API version
- 1.0.0
- Source
- developer.bulksms.com
- Provider
- bulksms.com
- Categories
- Telecommunications
- Last updated
Use this API in Bruno:
- Download the Bruno collection above and unzip it.
- In Bruno, choose Open Collection and select the unzipped folder.
- Set the
baseUrlvariable (for examplehttps://api.bulksms.com/v1) and your Basic auth credentials, then send requests.
POST
Upload an attachment via a signed URL
{{baseUrl}}/rmm/pre-sign-attachment
BODY json
{
"fileExtension": "",
"mediaType": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rmm/pre-sign-attachment");
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 \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/rmm/pre-sign-attachment" {:content-type :json
:form-params {:fileExtension ""
:mediaType ""}})require "http/client"
url = "{{baseUrl}}/rmm/pre-sign-attachment"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/rmm/pre-sign-attachment"),
Content = new StringContent("{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\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}}/rmm/pre-sign-attachment");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rmm/pre-sign-attachment"
payload := strings.NewReader("{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\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/rmm/pre-sign-attachment HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 44
{
"fileExtension": "",
"mediaType": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/rmm/pre-sign-attachment")
.setHeader("content-type", "application/json")
.setBody("{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rmm/pre-sign-attachment"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\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 \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/rmm/pre-sign-attachment")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/rmm/pre-sign-attachment")
.header("content-type", "application/json")
.body("{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}")
.asString(); const data = JSON.stringify({
fileExtension: '',
mediaType: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/rmm/pre-sign-attachment');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/rmm/pre-sign-attachment',
headers: {'content-type': 'application/json'},
data: {fileExtension: '', mediaType: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/rmm/pre-sign-attachment';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fileExtension":"","mediaType":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/rmm/pre-sign-attachment',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fileExtension": "",\n "mediaType": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/rmm/pre-sign-attachment")
.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/rmm/pre-sign-attachment',
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({fileExtension: '', mediaType: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/rmm/pre-sign-attachment',
headers: {'content-type': 'application/json'},
body: {fileExtension: '', mediaType: ''},
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}}/rmm/pre-sign-attachment');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fileExtension: '',
mediaType: ''
});
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}}/rmm/pre-sign-attachment',
headers: {'content-type': 'application/json'},
data: {fileExtension: '', mediaType: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/rmm/pre-sign-attachment';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fileExtension":"","mediaType":""}'
};
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 = @{ @"fileExtension": @"",
@"mediaType": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rmm/pre-sign-attachment"]
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}}/rmm/pre-sign-attachment" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/rmm/pre-sign-attachment",
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([
'fileExtension' => '',
'mediaType' => ''
]),
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}}/rmm/pre-sign-attachment', [
'body' => '{
"fileExtension": "",
"mediaType": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/rmm/pre-sign-attachment');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fileExtension' => '',
'mediaType' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'fileExtension' => '',
'mediaType' => ''
]));
$request->setRequestUrl('{{baseUrl}}/rmm/pre-sign-attachment');
$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}}/rmm/pre-sign-attachment' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fileExtension": "",
"mediaType": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rmm/pre-sign-attachment' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fileExtension": "",
"mediaType": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/rmm/pre-sign-attachment", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/rmm/pre-sign-attachment"
payload = {
"fileExtension": "",
"mediaType": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/rmm/pre-sign-attachment"
payload <- "{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\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}}/rmm/pre-sign-attachment")
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 \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/rmm/pre-sign-attachment') do |req|
req.body = "{\n \"fileExtension\": \"\",\n \"mediaType\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rmm/pre-sign-attachment";
let payload = json!({
"fileExtension": "",
"mediaType": ""
});
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}}/rmm/pre-sign-attachment \
--header 'content-type: application/json' \
--data '{
"fileExtension": "",
"mediaType": ""
}'echo '{
"fileExtension": "",
"mediaType": ""
}' | \
http POST {{baseUrl}}/rmm/pre-sign-attachment \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "fileExtension": "",\n "mediaType": ""\n}' \
--output-document \
- {{baseUrl}}/rmm/pre-sign-attachmentimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fileExtension": "",
"mediaType": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rmm/pre-sign-attachment")! 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
{
"fetchUrl": "https://smsattach.it/bedhkd.pdf",
"putUrl": "https://some.place/aethzd.pdf?Token=IQoJb3JpZ2luX2EP3"
}
POST
Create a blocked number
{{baseUrl}}/blocked-numbers
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/blocked-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 \"44123456789\"\n]");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/blocked-numbers" {:content-type :json
:form-params ["44123456789"]})require "http/client"
url = "{{baseUrl}}/blocked-numbers"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n \"44123456789\"\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/blocked-numbers"),
Content = new StringContent("[\n \"44123456789\"\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}}/blocked-numbers");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n \"44123456789\"\n]", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/blocked-numbers"
payload := strings.NewReader("[\n \"44123456789\"\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/blocked-numbers HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 19
[
"44123456789"
]AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/blocked-numbers")
.setHeader("content-type", "application/json")
.setBody("[\n \"44123456789\"\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/blocked-numbers"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n \"44123456789\"\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 \"44123456789\"\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/blocked-numbers")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/blocked-numbers")
.header("content-type", "application/json")
.body("[\n \"44123456789\"\n]")
.asString(); const data = JSON.stringify([
'44123456789'
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/blocked-numbers');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/blocked-numbers',
headers: {'content-type': 'application/json'},
data: ['44123456789']
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/blocked-numbers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '["44123456789"]'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/blocked-numbers',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n "44123456789"\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n \"44123456789\"\n]")
val request = Request.Builder()
.url("{{baseUrl}}/blocked-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/blocked-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(['44123456789']));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/blocked-numbers',
headers: {'content-type': 'application/json'},
body: ['44123456789'],
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}}/blocked-numbers');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
'44123456789'
]);
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}}/blocked-numbers',
headers: {'content-type': 'application/json'},
data: ['44123456789']
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/blocked-numbers';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '["44123456789"]'
};
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 = @[ @"44123456789" ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/blocked-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}}/blocked-numbers" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n \"44123456789\"\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/blocked-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([
'44123456789'
]),
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}}/blocked-numbers', [
'body' => '[
"44123456789"
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/blocked-numbers');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'44123456789'
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'44123456789'
]));
$request->setRequestUrl('{{baseUrl}}/blocked-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}}/blocked-numbers' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
"44123456789"
]'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/blocked-numbers' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
"44123456789"
]'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n \"44123456789\"\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/blocked-numbers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/blocked-numbers"
payload = ["44123456789"]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/blocked-numbers"
payload <- "[\n \"44123456789\"\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}}/blocked-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 \"44123456789\"\n]"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/blocked-numbers') do |req|
req.body = "[\n \"44123456789\"\n]"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/blocked-numbers";
let payload = ("44123456789");
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}}/blocked-numbers \
--header 'content-type: application/json' \
--data '[
"44123456789"
]'echo '[
"44123456789"
]' | \
http POST {{baseUrl}}/blocked-numbers \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n "44123456789"\n]' \
--output-document \
- {{baseUrl}}/blocked-numbersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["44123456789"] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/blocked-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()
GET
List blocked numbers
{{baseUrl}}/blocked-numbers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/blocked-numbers");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/blocked-numbers")require "http/client"
url = "{{baseUrl}}/blocked-numbers"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/blocked-numbers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/blocked-numbers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/blocked-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/blocked-numbers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/blocked-numbers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/blocked-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}}/blocked-numbers")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/blocked-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}}/blocked-numbers');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/blocked-numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/blocked-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}}/blocked-numbers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/blocked-numbers")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/blocked-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}}/blocked-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}}/blocked-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}}/blocked-numbers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/blocked-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}}/blocked-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}}/blocked-numbers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/blocked-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}}/blocked-numbers');
echo $response->getBody();setUrl('{{baseUrl}}/blocked-numbers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/blocked-numbers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/blocked-numbers' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/blocked-numbers' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/blocked-numbers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/blocked-numbers"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/blocked-numbers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/blocked-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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/blocked-numbers') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/blocked-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}}/blocked-numbershttp GET {{baseUrl}}/blocked-numberswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/blocked-numbersimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/blocked-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
{
"id": 234
}
POST
Transfer credits to another account
{{baseUrl}}/credit/transfer
BODY json
{
"commentOnFrom": "",
"commentOnTo": "",
"credits": "",
"toUserId": "",
"toUsername": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/credit/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 \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/credit/transfer" {:content-type :json
:form-params {:commentOnFrom "Tranfer to Bobby"
:commentOnTo "Tranfer from Danny"
:credits 2345
:toUserId 2345
:toUsername "roboto"}})require "http/client"
url = "{{baseUrl}}/credit/transfer"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/credit/transfer"),
Content = new StringContent("{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\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}}/credit/transfer");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/credit/transfer"
payload := strings.NewReader("{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\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/credit/transfer HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 145
{
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/credit/transfer")
.setHeader("content-type", "application/json")
.setBody("{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/credit/transfer"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\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 \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/credit/transfer")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/credit/transfer")
.header("content-type", "application/json")
.body("{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}")
.asString(); const data = JSON.stringify({
commentOnFrom: 'Tranfer to Bobby',
commentOnTo: 'Tranfer from Danny',
credits: 2345,
toUserId: 2345,
toUsername: 'roboto'
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/credit/transfer');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/credit/transfer',
headers: {'content-type': 'application/json'},
data: {
commentOnFrom: 'Tranfer to Bobby',
commentOnTo: 'Tranfer from Danny',
credits: 2345,
toUserId: 2345,
toUsername: 'roboto'
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/credit/transfer';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"commentOnFrom":"Tranfer to Bobby","commentOnTo":"Tranfer from Danny","credits":2345,"toUserId":2345,"toUsername":"roboto"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/credit/transfer',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "commentOnFrom": "Tranfer to Bobby",\n "commentOnTo": "Tranfer from Danny",\n "credits": 2345,\n "toUserId": 2345,\n "toUsername": "roboto"\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/credit/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/credit/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({
commentOnFrom: 'Tranfer to Bobby',
commentOnTo: 'Tranfer from Danny',
credits: 2345,
toUserId: 2345,
toUsername: 'roboto'
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/credit/transfer',
headers: {'content-type': 'application/json'},
body: {
commentOnFrom: 'Tranfer to Bobby',
commentOnTo: 'Tranfer from Danny',
credits: 2345,
toUserId: 2345,
toUsername: 'roboto'
},
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}}/credit/transfer');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
commentOnFrom: 'Tranfer to Bobby',
commentOnTo: 'Tranfer from Danny',
credits: 2345,
toUserId: 2345,
toUsername: 'roboto'
});
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}}/credit/transfer',
headers: {'content-type': 'application/json'},
data: {
commentOnFrom: 'Tranfer to Bobby',
commentOnTo: 'Tranfer from Danny',
credits: 2345,
toUserId: 2345,
toUsername: 'roboto'
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/credit/transfer';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"commentOnFrom":"Tranfer to Bobby","commentOnTo":"Tranfer from Danny","credits":2345,"toUserId":2345,"toUsername":"roboto"}'
};
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 = @{ @"commentOnFrom": @"Tranfer to Bobby",
@"commentOnTo": @"Tranfer from Danny",
@"credits": @2345,
@"toUserId": @2345,
@"toUsername": @"roboto" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/credit/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}}/credit/transfer" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/credit/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([
'commentOnFrom' => 'Tranfer to Bobby',
'commentOnTo' => 'Tranfer from Danny',
'credits' => 2345,
'toUserId' => 2345,
'toUsername' => 'roboto'
]),
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}}/credit/transfer', [
'body' => '{
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/credit/transfer');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'commentOnFrom' => 'Tranfer to Bobby',
'commentOnTo' => 'Tranfer from Danny',
'credits' => 2345,
'toUserId' => 2345,
'toUsername' => 'roboto'
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'commentOnFrom' => 'Tranfer to Bobby',
'commentOnTo' => 'Tranfer from Danny',
'credits' => 2345,
'toUserId' => 2345,
'toUsername' => 'roboto'
]));
$request->setRequestUrl('{{baseUrl}}/credit/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}}/credit/transfer' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/credit/transfer' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/credit/transfer", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/credit/transfer"
payload = {
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/credit/transfer"
payload <- "{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\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}}/credit/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 \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/credit/transfer') do |req|
req.body = "{\n \"commentOnFrom\": \"Tranfer to Bobby\",\n \"commentOnTo\": \"Tranfer from Danny\",\n \"credits\": 2345,\n \"toUserId\": 2345,\n \"toUsername\": \"roboto\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/credit/transfer";
let payload = json!({
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
});
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}}/credit/transfer \
--header 'content-type: application/json' \
--data '{
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
}'echo '{
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
}' | \
http POST {{baseUrl}}/credit/transfer \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "commentOnFrom": "Tranfer to Bobby",\n "commentOnTo": "Tranfer from Danny",\n "credits": 2345,\n "toUserId": 2345,\n "toUsername": "roboto"\n}' \
--output-document \
- {{baseUrl}}/credit/transferimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"commentOnFrom": "Tranfer to Bobby",
"commentOnTo": "Tranfer from Danny",
"credits": 2345,
"toUserId": 2345,
"toUsername": "roboto"
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/credit/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()
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messages/:id/relatedReceivedMessages");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messages/:id/relatedReceivedMessages")require "http/client"
url = "{{baseUrl}}/messages/:id/relatedReceivedMessages"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messages/:id/relatedReceivedMessages"),
};
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/relatedReceivedMessages");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messages/:id/relatedReceivedMessages"
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/relatedReceivedMessages HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messages/:id/relatedReceivedMessages")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messages/:id/relatedReceivedMessages"))
.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/relatedReceivedMessages")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/messages/:id/relatedReceivedMessages")
.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/relatedReceivedMessages');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/messages/:id/relatedReceivedMessages'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/messages/:id/relatedReceivedMessages';
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/relatedReceivedMessages',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messages/:id/relatedReceivedMessages")
.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/relatedReceivedMessages',
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/relatedReceivedMessages'
};
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/relatedReceivedMessages');
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/relatedReceivedMessages'
};
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/relatedReceivedMessages';
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/relatedReceivedMessages"]
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/relatedReceivedMessages" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/messages/:id/relatedReceivedMessages",
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/relatedReceivedMessages');
echo $response->getBody();setUrl('{{baseUrl}}/messages/:id/relatedReceivedMessages');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/messages/:id/relatedReceivedMessages');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/messages/:id/relatedReceivedMessages' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/messages/:id/relatedReceivedMessages' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messages/:id/relatedReceivedMessages")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/messages/:id/relatedReceivedMessages"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/messages/:id/relatedReceivedMessages"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messages/:id/relatedReceivedMessages")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messages/:id/relatedReceivedMessages') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages/:id/relatedReceivedMessages";
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/relatedReceivedMessageshttp GET {{baseUrl}}/messages/:id/relatedReceivedMessageswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messages/:id/relatedReceivedMessagesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messages/:id/relatedReceivedMessages")! 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 Messages
{{baseUrl}}/messages
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messages");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messages")require "http/client"
url = "{{baseUrl}}/messages"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messages"),
};
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.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messages"
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 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messages")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messages"))
.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")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/messages")
.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');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/messages'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/messages';
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',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messages")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messages',
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'};
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');
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'};
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: '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"]
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" in
Client.call `GET 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 => "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');
echo $response->getBody();setUrl('{{baseUrl}}/messages');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/messages');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/messages' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/messages' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messages")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/messages"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/messages"
response <- VERB("GET", url, content_type("application/octet-stream"))
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::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messages') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages";
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}}/messageshttp GET {{baseUrl}}/messageswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messagesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messages")! 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
Send Messages
{{baseUrl}}/messages
BODY json
[
{
"body": "",
"deliveryReports": "",
"encoding": "",
"from": {
"address": "",
"type": ""
},
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
{
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
}
],
"userSuppliedId": ""
}
]
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 {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\n]");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/messages" {:content-type :json
:form-params [{:body ""
:deliveryReports ""
:encoding ""
:from {:address ""
:type ""}
:longMessageMaxParts 0
:messageClass ""
:protocolId ""
:routingGroup ""
:to [{:address ""
:fields []
:id ""
:name ""
:type ""}]
:userSuppliedId ""}]})require "http/client"
url = "{{baseUrl}}/messages"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/messages"),
Content = new StringContent("[\n {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\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}}/messages");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\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 {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\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/messages HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 395
[
{
"body": "",
"deliveryReports": "",
"encoding": "",
"from": {
"address": "",
"type": ""
},
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
{
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
}
],
"userSuppliedId": ""
}
]AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/messages")
.setHeader("content-type", "application/json")
.setBody("[\n {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\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 {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\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 {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\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 {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\n]")
.asString(); const data = JSON.stringify([
{
body: '',
deliveryReports: '',
encoding: '',
from: {
address: '',
type: ''
},
longMessageMaxParts: 0,
messageClass: '',
protocolId: '',
routingGroup: '',
to: [
{
address: '',
fields: [],
id: '',
name: '',
type: ''
}
],
userSuppliedId: ''
}
]);
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: [
{
body: '',
deliveryReports: '',
encoding: '',
from: {address: '', type: ''},
longMessageMaxParts: 0,
messageClass: '',
protocolId: '',
routingGroup: '',
to: [{address: '', fields: [], id: '', name: '', type: ''}],
userSuppliedId: ''
}
]
};
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: '[{"body":"","deliveryReports":"","encoding":"","from":{"address":"","type":""},"longMessageMaxParts":0,"messageClass":"","protocolId":"","routingGroup":"","to":[{"address":"","fields":[],"id":"","name":"","type":""}],"userSuppliedId":""}]'
};
try {
const response = await 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 {\n "body": "",\n "deliveryReports": "",\n "encoding": "",\n "from": {\n "address": "",\n "type": ""\n },\n "longMessageMaxParts": 0,\n "messageClass": "",\n "protocolId": "",\n "routingGroup": "",\n "to": [\n {\n "address": "",\n "fields": [],\n "id": "",\n "name": "",\n "type": ""\n }\n ],\n "userSuppliedId": ""\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 {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\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([
{
body: '',
deliveryReports: '',
encoding: '',
from: {address: '', type: ''},
longMessageMaxParts: 0,
messageClass: '',
protocolId: '',
routingGroup: '',
to: [{address: '', fields: [], id: '', name: '', type: ''}],
userSuppliedId: ''
}
]));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/messages',
headers: {'content-type': 'application/json'},
body: [
{
body: '',
deliveryReports: '',
encoding: '',
from: {address: '', type: ''},
longMessageMaxParts: 0,
messageClass: '',
protocolId: '',
routingGroup: '',
to: [{address: '', fields: [], id: '', name: '', type: ''}],
userSuppliedId: ''
}
],
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([
{
body: '',
deliveryReports: '',
encoding: '',
from: {
address: '',
type: ''
},
longMessageMaxParts: 0,
messageClass: '',
protocolId: '',
routingGroup: '',
to: [
{
address: '',
fields: [],
id: '',
name: '',
type: ''
}
],
userSuppliedId: ''
}
]);
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: [
{
body: '',
deliveryReports: '',
encoding: '',
from: {address: '', type: ''},
longMessageMaxParts: 0,
messageClass: '',
protocolId: '',
routingGroup: '',
to: [{address: '', fields: [], id: '', name: '', type: ''}],
userSuppliedId: ''
}
]
};
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: '[{"body":"","deliveryReports":"","encoding":"","from":{"address":"","type":""},"longMessageMaxParts":0,"messageClass":"","protocolId":"","routingGroup":"","to":[{"address":"","fields":[],"id":"","name":"","type":""}],"userSuppliedId":""}]'
};
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": @"", @"deliveryReports": @"", @"encoding": @"", @"from": @{ @"address": @"", @"type": @"" }, @"longMessageMaxParts": @0, @"messageClass": @"", @"protocolId": @"", @"routingGroup": @"", @"to": @[ @{ @"address": @"", @"fields": @[ ], @"id": @"", @"name": @"", @"type": @"" } ], @"userSuppliedId": @"" } ];
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 {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\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([
[
'body' => '',
'deliveryReports' => '',
'encoding' => '',
'from' => [
'address' => '',
'type' => ''
],
'longMessageMaxParts' => 0,
'messageClass' => '',
'protocolId' => '',
'routingGroup' => '',
'to' => [
[
'address' => '',
'fields' => [
],
'id' => '',
'name' => '',
'type' => ''
]
],
'userSuppliedId' => ''
]
]),
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' => '[
{
"body": "",
"deliveryReports": "",
"encoding": "",
"from": {
"address": "",
"type": ""
},
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
{
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
}
],
"userSuppliedId": ""
}
]',
'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([
[
'body' => '',
'deliveryReports' => '',
'encoding' => '',
'from' => [
'address' => '',
'type' => ''
],
'longMessageMaxParts' => 0,
'messageClass' => '',
'protocolId' => '',
'routingGroup' => '',
'to' => [
[
'address' => '',
'fields' => [
],
'id' => '',
'name' => '',
'type' => ''
]
],
'userSuppliedId' => ''
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
[
'body' => '',
'deliveryReports' => '',
'encoding' => '',
'from' => [
'address' => '',
'type' => ''
],
'longMessageMaxParts' => 0,
'messageClass' => '',
'protocolId' => '',
'routingGroup' => '',
'to' => [
[
'address' => '',
'fields' => [
],
'id' => '',
'name' => '',
'type' => ''
]
],
'userSuppliedId' => ''
]
]));
$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 '[
{
"body": "",
"deliveryReports": "",
"encoding": "",
"from": {
"address": "",
"type": ""
},
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
{
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
}
],
"userSuppliedId": ""
}
]'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/messages' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"body": "",
"deliveryReports": "",
"encoding": "",
"from": {
"address": "",
"type": ""
},
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
{
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
}
],
"userSuppliedId": ""
}
]'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\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 = [
{
"body": "",
"deliveryReports": "",
"encoding": "",
"from": {
"address": "",
"type": ""
},
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
{
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
}
],
"userSuppliedId": ""
}
]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/messages"
payload <- "[\n {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\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}}/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 {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\n]"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/messages') do |req|
req.body = "[\n {\n \"body\": \"\",\n \"deliveryReports\": \"\",\n \"encoding\": \"\",\n \"from\": {\n \"address\": \"\",\n \"type\": \"\"\n },\n \"longMessageMaxParts\": 0,\n \"messageClass\": \"\",\n \"protocolId\": \"\",\n \"routingGroup\": \"\",\n \"to\": [\n {\n \"address\": \"\",\n \"fields\": [],\n \"id\": \"\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ],\n \"userSuppliedId\": \"\"\n }\n]"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages";
let payload = (
json!({
"body": "",
"deliveryReports": "",
"encoding": "",
"from": json!({
"address": "",
"type": ""
}),
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": (
json!({
"address": "",
"fields": (),
"id": "",
"name": "",
"type": ""
})
),
"userSuppliedId": ""
})
);
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 '[
{
"body": "",
"deliveryReports": "",
"encoding": "",
"from": {
"address": "",
"type": ""
},
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
{
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
}
],
"userSuppliedId": ""
}
]'echo '[
{
"body": "",
"deliveryReports": "",
"encoding": "",
"from": {
"address": "",
"type": ""
},
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
{
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
}
],
"userSuppliedId": ""
}
]' | \
http POST {{baseUrl}}/messages \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {\n "body": "",\n "deliveryReports": "",\n "encoding": "",\n "from": {\n "address": "",\n "type": ""\n },\n "longMessageMaxParts": 0,\n "messageClass": "",\n "protocolId": "",\n "routingGroup": "",\n "to": [\n {\n "address": "",\n "fields": [],\n "id": "",\n "name": "",\n "type": ""\n }\n ],\n "userSuppliedId": ""\n }\n]' \
--output-document \
- {{baseUrl}}/messagesimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
[
"body": "",
"deliveryReports": "",
"encoding": "",
"from": [
"address": "",
"type": ""
],
"longMessageMaxParts": 0,
"messageClass": "",
"protocolId": "",
"routingGroup": "",
"to": [
[
"address": "",
"fields": [],
"id": "",
"name": "",
"type": ""
]
],
"userSuppliedId": ""
]
] 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
{
"status": 403,
"title": "Insufficient Credits",
"type": "https://developer.bulksms.com/json/v1/errors#insufficient-credits"
}
GET
Send message by simple GET or POST
{{baseUrl}}/messages/send
QUERY PARAMS
to
body
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/messages/send?to=&body=");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/messages/send" {:query-params {:to ""
:body ""}})require "http/client"
url = "{{baseUrl}}/messages/send?to=&body="
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/messages/send?to=&body="),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/messages/send?to=&body=");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/messages/send?to=&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/messages/send?to=&body= HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/messages/send?to=&body=")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/messages/send?to=&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}}/messages/send?to=&body=")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/messages/send?to=&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}}/messages/send?to=&body=');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/messages/send',
params: {to: '', body: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/messages/send?to=&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}}/messages/send?to=&body=',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/messages/send?to=&body=")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/messages/send?to=&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}}/messages/send',
qs: {to: '', 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}}/messages/send');
req.query({
to: '',
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}}/messages/send',
params: {to: '', body: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/messages/send?to=&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}}/messages/send?to=&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}}/messages/send?to=&body=" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/messages/send?to=&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}}/messages/send?to=&body=');
echo $response->getBody();setUrl('{{baseUrl}}/messages/send');
$request->setMethod(HTTP_METH_GET);
$request->setQueryData([
'to' => '',
'body' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/messages/send');
$request->setRequestMethod('GET');
$request->setQuery(new http\QueryString([
'to' => '',
'body' => ''
]));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/messages/send?to=&body=' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/messages/send?to=&body=' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/messages/send?to=&body=")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/messages/send"
querystring = {"to":"","body":""}
response = requests.get(url, params=querystring)
print(response.json())library(httr)
url <- "{{baseUrl}}/messages/send"
queryString <- list(
to = "",
body = ""
)
response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/messages/send?to=&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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messages/send') do |req|
req.params['to'] = ''
req.params['body'] = ''
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/messages/send";
let querystring = [
("to", ""),
("body", ""),
];
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}}/messages/send?to=&body='http GET '{{baseUrl}}/messages/send?to=&body='wget --quiet \
--method GET \
--output-document \
- '{{baseUrl}}/messages/send?to=&body='import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/messages/send?to=&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
{
"status": 403,
"title": "Insufficient Credits",
"type": "https://developer.bulksms.com/json/v1/errors#insufficient-credits"
}
GET
Show 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.bodyusing 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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/messages/:id') do |req|
end
puts response.status
puts response.bodyuse 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/:idhttp GET {{baseUrl}}/messages/:idwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/messages/:idimport 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()
GET
Get profile
{{baseUrl}}/profile
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/profile");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/profile")require "http/client"
url = "{{baseUrl}}/profile"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/profile"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/profile");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/profile"
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/profile HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/profile")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/profile"))
.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}}/profile")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/profile")
.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}}/profile');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/profile'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/profile';
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}}/profile',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/profile")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/profile',
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}}/profile'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/profile');
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}}/profile'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/profile';
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}}/profile"]
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}}/profile" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/profile",
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}}/profile');
echo $response->getBody();setUrl('{{baseUrl}}/profile');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/profile');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/profile' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/profile' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/profile")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/profile"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/profile"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/profile")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/profile') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/profile";
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}}/profilehttp GET {{baseUrl}}/profilewget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/profileimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/profile")! 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
null
POST
Create a webhook
{{baseUrl}}/webhooks
BODY json
{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks");
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 \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/webhooks" {:content-type :json
:form-params {:active false
:contactEmailAddress ""
:invokeOption ""
:name ""
:onWebApp false
:triggerScope ""
:url ""}})require "http/client"
url = "{{baseUrl}}/webhooks"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/webhooks"),
Content = new StringContent("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"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}}/webhooks");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks"
payload := strings.NewReader("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"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/webhooks HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 142
{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/webhooks")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"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 \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/webhooks")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/webhooks")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}")
.asString(); const data = JSON.stringify({
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
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}}/webhooks');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/webhooks',
headers: {'content-type': 'application/json'},
data: {
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/webhooks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"contactEmailAddress":"","invokeOption":"","name":"","onWebApp":false,"triggerScope":"","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}}/webhooks',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "contactEmailAddress": "",\n "invokeOption": "",\n "name": "",\n "onWebApp": false,\n "triggerScope": "",\n "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 \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/webhooks")
.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/webhooks',
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,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
url: ''
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/webhooks',
headers: {'content-type': 'application/json'},
body: {
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
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}}/webhooks');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
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}}/webhooks',
headers: {'content-type': 'application/json'},
data: {
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"contactEmailAddress":"","invokeOption":"","name":"","onWebApp":false,"triggerScope":"","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,
@"contactEmailAddress": @"",
@"invokeOption": @"",
@"name": @"",
@"onWebApp": @NO,
@"triggerScope": @"",
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhooks"]
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}}/webhooks" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/webhooks",
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,
'contactEmailAddress' => '',
'invokeOption' => '',
'name' => '',
'onWebApp' => null,
'triggerScope' => '',
'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}}/webhooks', [
'body' => '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/webhooks');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'contactEmailAddress' => '',
'invokeOption' => '',
'name' => '',
'onWebApp' => null,
'triggerScope' => '',
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'active' => null,
'contactEmailAddress' => '',
'invokeOption' => '',
'name' => '',
'onWebApp' => null,
'triggerScope' => '',
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/webhooks');
$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}}/webhooks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/webhooks", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/webhooks"
payload = {
"active": False,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": False,
"triggerScope": "",
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/webhooks"
payload <- "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"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}}/webhooks")
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 \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/webhooks') do |req|
req.body = "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks";
let payload = json!({
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"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}}/webhooks \
--header 'content-type: application/json' \
--data '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}'echo '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}' | \
http POST {{baseUrl}}/webhooks \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "contactEmailAddress": "",\n "invokeOption": "",\n "name": "",\n "onWebApp": false,\n "triggerScope": "",\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/webhooksimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks")! 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
{
"active": true,
"contactEmailAddress": "tech_team@example.com",
"id": 234,
"name": "My MT Webhook",
"onWebApp": true,
"triggerScope": "SENT",
"url": "https://www.example.com"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"detail": "Invoking the Webhook URL caused an error: 403 - Forbidden\n",
"status": 400,
"title": "Bad Request",
"type": "https://developer.bulksms.com/json/v1/errors/#bad-request"
}
DELETE
Delete a webhook
{{baseUrl}}/webhooks/:id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks/:id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/webhooks/:id")require "http/client"
url = "{{baseUrl}}/webhooks/:id"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/webhooks/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/webhooks/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks/: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/webhooks/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/webhooks/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks/: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}}/webhooks/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/webhooks/: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}}/webhooks/:id');
xhr.send(data);import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/webhooks/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/webhooks/: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}}/webhooks/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/webhooks/: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/webhooks/: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}}/webhooks/: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}}/webhooks/: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}}/webhooks/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks/: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}}/webhooks/: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}}/webhooks/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/webhooks/: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}}/webhooks/:id');
echo $response->getBody();setUrl('{{baseUrl}}/webhooks/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/webhooks/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/webhooks/:id' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks/:id' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/webhooks/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/webhooks/:id"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/webhooks/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/webhooks/: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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/webhooks/:id') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks/: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}}/webhooks/:idhttp DELETE {{baseUrl}}/webhooks/:idwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/webhooks/:idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks/: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
{
"detail": "Webhook with id '1' does not exist\n",
"status": 404,
"title": "Not Found",
"type": "https://developer.bulksms.com/json/v1/errors/#not-found"
}
GET
List webhooks
{{baseUrl}}/webhooks
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/webhooks")require "http/client"
url = "{{baseUrl}}/webhooks"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/webhooks"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/webhooks");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks"
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/webhooks HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/webhooks")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks"))
.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}}/webhooks")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/webhooks")
.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}}/webhooks');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/webhooks'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/webhooks';
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}}/webhooks',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/webhooks")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/webhooks',
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}}/webhooks'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/webhooks');
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}}/webhooks'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks';
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}}/webhooks"]
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}}/webhooks" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/webhooks",
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}}/webhooks');
echo $response->getBody();setUrl('{{baseUrl}}/webhooks');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/webhooks');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/webhooks' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/webhooks")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/webhooks"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/webhooks"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/webhooks")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/webhooks') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks";
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}}/webhookshttp GET {{baseUrl}}/webhookswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/webhooksimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks")! 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
[
{
"active": true,
"contactEmailAddress": "tech_team@example.com",
"id": 234,
"name": "My MT Webhook",
"onWebApp": true,
"triggerScope": "SENT",
"url": "https://www.example.com"
}
]
GET
Read a webhook
{{baseUrl}}/webhooks/:id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks/:id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/webhooks/:id")require "http/client"
url = "{{baseUrl}}/webhooks/:id"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/webhooks/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/webhooks/:id");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks/: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/webhooks/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/webhooks/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks/: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}}/webhooks/:id")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/webhooks/: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}}/webhooks/:id');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/webhooks/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/webhooks/: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}}/webhooks/:id',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/webhooks/:id")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/webhooks/: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}}/webhooks/: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}}/webhooks/: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}}/webhooks/:id'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks/: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}}/webhooks/: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}}/webhooks/:id" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/webhooks/: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}}/webhooks/:id');
echo $response->getBody();setUrl('{{baseUrl}}/webhooks/:id');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/webhooks/:id');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/webhooks/:id' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks/:id' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/webhooks/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/webhooks/:id"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/webhooks/:id"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/webhooks/: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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/webhooks/:id') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks/: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}}/webhooks/:idhttp GET {{baseUrl}}/webhooks/:idwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/webhooks/:idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks/: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
{
"active": true,
"contactEmailAddress": "tech_team@example.com",
"id": 234,
"name": "My MT Webhook",
"onWebApp": true,
"triggerScope": "SENT",
"url": "https://www.example.com"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"detail": "Invoking the Webhook URL caused an error: 403 - Forbidden\n",
"status": 400,
"title": "Bad Request",
"type": "https://developer.bulksms.com/json/v1/errors/#bad-request"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"detail": "Webhook with id '1' does not exist\n",
"status": 404,
"title": "Not Found",
"type": "https://developer.bulksms.com/json/v1/errors/#not-found"
}
POST
Update a webhook
{{baseUrl}}/webhooks/:id
BODY json
{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/webhooks/: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 \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/webhooks/:id" {:content-type :json
:form-params {:active false
:contactEmailAddress ""
:invokeOption ""
:name ""
:onWebApp false
:triggerScope ""
:url ""}})require "http/client"
url = "{{baseUrl}}/webhooks/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/webhooks/:id"),
Content = new StringContent("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"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}}/webhooks/:id");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/webhooks/:id"
payload := strings.NewReader("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"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/webhooks/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 142
{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/webhooks/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/webhooks/:id"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"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 \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/webhooks/:id")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/webhooks/:id")
.header("content-type", "application/json")
.body("{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}")
.asString(); const data = JSON.stringify({
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
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}}/webhooks/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/webhooks/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/webhooks/:id';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"contactEmailAddress":"","invokeOption":"","name":"","onWebApp":false,"triggerScope":"","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}}/webhooks/:id',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "active": false,\n "contactEmailAddress": "",\n "invokeOption": "",\n "name": "",\n "onWebApp": false,\n "triggerScope": "",\n "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 \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/webhooks/:id")
.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/webhooks/: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,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
url: ''
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/webhooks/:id',
headers: {'content-type': 'application/json'},
body: {
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
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}}/webhooks/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
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}}/webhooks/:id',
headers: {'content-type': 'application/json'},
data: {
active: false,
contactEmailAddress: '',
invokeOption: '',
name: '',
onWebApp: false,
triggerScope: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/webhooks/:id';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"active":false,"contactEmailAddress":"","invokeOption":"","name":"","onWebApp":false,"triggerScope":"","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,
@"contactEmailAddress": @"",
@"invokeOption": @"",
@"name": @"",
@"onWebApp": @NO,
@"triggerScope": @"",
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/webhooks/:id"]
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}}/webhooks/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/webhooks/:id",
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,
'contactEmailAddress' => '',
'invokeOption' => '',
'name' => '',
'onWebApp' => null,
'triggerScope' => '',
'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}}/webhooks/:id', [
'body' => '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/webhooks/:id');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'active' => null,
'contactEmailAddress' => '',
'invokeOption' => '',
'name' => '',
'onWebApp' => null,
'triggerScope' => '',
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'active' => null,
'contactEmailAddress' => '',
'invokeOption' => '',
'name' => '',
'onWebApp' => null,
'triggerScope' => '',
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/webhooks/:id');
$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}}/webhooks/:id' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/webhooks/:id' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/webhooks/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/webhooks/:id"
payload = {
"active": False,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": False,
"triggerScope": "",
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/webhooks/:id"
payload <- "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"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}}/webhooks/:id")
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 \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/webhooks/:id') do |req|
req.body = "{\n \"active\": false,\n \"contactEmailAddress\": \"\",\n \"invokeOption\": \"\",\n \"name\": \"\",\n \"onWebApp\": false,\n \"triggerScope\": \"\",\n \"url\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/webhooks/:id";
let payload = json!({
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"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}}/webhooks/:id \
--header 'content-type: application/json' \
--data '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}'echo '{
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
}' | \
http POST {{baseUrl}}/webhooks/:id \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "active": false,\n "contactEmailAddress": "",\n "invokeOption": "",\n "name": "",\n "onWebApp": false,\n "triggerScope": "",\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/webhooks/:idimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"active": false,
"contactEmailAddress": "",
"invokeOption": "",
"name": "",
"onWebApp": false,
"triggerScope": "",
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/webhooks/:id")! 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
{
"active": true,
"contactEmailAddress": "tech_team@example.com",
"id": 234,
"name": "My MT Webhook",
"onWebApp": true,
"triggerScope": "SENT",
"url": "https://www.example.com"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"detail": "Webhook with id '1' does not exist\n",
"status": 404,
"title": "Not Found",
"type": "https://developer.bulksms.com/json/v1/errors/#not-found"
}