Search SMS
SearchOutboundSMS
POST https://api.opentact.org/rest/sms/search/outbound
This will search all outbound SMS.
Query Parameters
Name
Type
Description
skip
integer
>= 0 Default: 0
take
integer
[ 1 .. 100 ] Default: 10
Headers
Name
Type
Description
Content-Type
string
application/json
Authorization
string
JWT or Bearer
Request Body
Name
Type
Description
tn
number
take
integer
[ 1 .. 100 ] Default: "10" How many items to take
skip
integer
>= 0 Default: "0" How many items to skip
mode
string
(ESearchMode) Enum: "AND" "OR"
order
object
Order items by field's accepted values: · tn · to · message · state · created_on · modified_on · reference_id · delivered
created_on_from
string
created_on_to
string
modified_on_from
string
<date-time>
modified_on_to
string
<date-time>
message
string
[ 1 .. 918 ] characters Mask Supported
from
string
[ 3 .. 255 ] characters Mask Supported
to
string
[ 3 .. 255 ] characters Mask Supported
delivered
boolean
state
string
reference_id
string
Code Example
curl -X POST "https://api.opentact.org/rest/sms/search/outbound?take=10&skip=0" \
-H "accept: application/json" -H "X-Auth-Token: JWT_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"take\":10,\"skip\":0,\"mode\":\"AND\",\"order\":{},\"created_on_from\":\"2020-10-27T11:37:34.923Z\",\"created_on_to\":\"2020-10-27T11:37:34.923Z\",\"modified_on_from\":\"2020-10-27T11:37:34.923Z\",\"modified_on_to\":\"2020-10-27T11:37:34.923Z\",\"message\":\"string\",\"tn\":0,\"to\":\"string\",\"delivered\":true,\"state\":\"created\",\"reference_id\":\"string\"}"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-Token' => 'JWT_TOKEN',
'Content-Type' => 'application/json'
);
$data = '{"take":10,"skip":0,"mode":"AND","order":{},"created_on_from":"2020-10-27T11:37:34.923Z","created_on_to":"2020-10-27T11:37:34.923Z","modified_on_from":"2020-10-27T11:37:34.923Z","modified_on_to":"2020-10-27T11:37:34.923Z","message":"string","tn":0,"to":"string","delivered":true,"state":"created","reference_id":"string"}';
$response = Requests::post('https://api.opentact.org/rest/sms/search/outbound?take=10&skip=0', $headers, $data);
import requests
headers = {
'accept': 'application/json',
'X-Auth-Token': 'JWT_TOKEN',
'Content-Type': 'application/json',
}
params = (
('take', '10'),
('skip', '0'),
)
data = '{"take":10,"skip":0,"mode":"AND","order":{},"created_on_from":"2020-10-27T11:37:34.923Z","created_on_to":"2020-10-27T11:37:34.923Z","modified_on_from":"2020-10-27T11:37:34.923Z","modified_on_to":"2020-10-27T11:37:34.923Z","message":"string","tn":0,"to":"string","delivered":true,"state":"created","reference_id":"string"}'
response = requests.post('https://api.opentact.org/rest/sms/search/outbound', headers=headers, params=params, data=data)
#NB. Original query string below. It seems impossible to parse and
#reproduce query strings 100% accurately so the one below is given
#in case the reproduced version is not "correct".
# response = requests.post('https://api.opentact.org/rest/sms/search/outbound?take=10&skip=0', headers=headers, data=data)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/sms/search/outbound?take=10&skip=0', {
method: 'POST',
headers: {
'accept': 'application/json',
'X-Auth-Token': 'JWT_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({"take":10,"skip":0,"mode":"AND","order":{},"created_on_from":"2020-10-27T11:37:34.923Z","created_on_to":"2020-10-27T11:37:34.923Z","modified_on_from":"2020-10-27T11:37:34.923Z","modified_on_to":"2020-10-27T11:37:34.923Z","message":"string","tn":0,"to":"string","delivered":true,"state":"created","reference_id":"string"})
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{"take":10,"skip":0,"mode":"AND","order":{},"created_on_from":"2020-10-27T11:37:34.923Z","created_on_to":"2020-10-27T11:37:34.923Z","modified_on_from":"2020-10-27T11:37:34.923Z","modified_on_to":"2020-10-27T11:37:34.923Z","message":"string","tn":0,"to":"string","delivered":true,"state":"created","reference_id":"string"}`)
req, err := http.NewRequest("POST", "https://api.opentact.org/rest/sms/search/outbound?take=10&skip=0", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-Token", "JWT_TOKEN")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s\n", bodyText)
}
SearchInboundSMS
POST https://api.opentact.org/rest/sms/search/inbound
This will search all inbound SMS.
Query Parameters
Name
Type
Description
skip
integer
>= 0 Default: 0
take
integer
[ 1 .. 100 ] Default: 10
Request Body
Name
Type
Description
tn
integer
take
integer
[ 1 .. 100 ] Default: "10" How many items to take
skip
integer
>= 0 Default: "0" How many items to skip
mode
string
(ESearchMode) Enum: "AND" "OR"
order
object
Order items by field's accepted values: · tn · to · message · state · created_on · modified_on · reference_id · delivered
created_on_from
string
created_on_to
string
modified_on_from
string
<date-time>
modified_on_to
string
<date-time>
message
string
[ 1 .. 918 ] characters Mask Supported
from
string
[ 3 .. 255 ] characters Mask Supported
to
string
[ 3 .. 255 ] characters Mask Supported
delivered
boolean
readed
boolean
state
string
(ESMSIState) Enum: "created" "success" "failed"
{
"success": true,
"payload": {
"total": 0,
"take": 10,
"skip": 0,
"data": []
}
}Code Example
curl -X POST "https://api.opentact.org/rest/sms/search/inbound?take=10&skip=0" \
-H "accept: application/json" -H "X-Auth-Token: JWT_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"take\":10,\"skip\":0,\"mode\":\"AND\",\"order\":{\"delivered\":\"ASC\"},\"created_on_from\":\"2020-10-27T12:22:07.076Z\",\"created_on_to\":\"2020-10-27T12:22:07.076Z\",\"modified_on_from\":\"2020-10-27T12:22:07.076Z\",\"modified_on_to\":\"2020-10-27T12:22:07.076Z\",\"message\":\"string\",\"tn\":0,\"to\":\"string\",\"from\":\"string\",\"delivered\":true,\"readed\":true,\"state\":\"created\"}"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-Token' => 'JWT_TOKEN',
'Content-Type' => 'application/json'
);
$data = '{"take":10,"skip":0,"mode":"AND","order":{"delivered":"ASC"},"created_on_from":"2020-10-27T12:22:07.076Z","created_on_to":"2020-10-27T12:22:07.076Z","modified_on_from":"2020-10-27T12:22:07.076Z","modified_on_to":"2020-10-27T12:22:07.076Z","message":"string","tn":0,"to":"string","from":"string","delivered":true,"readed":true,"state":"created"}';
$response = Requests::post('https://api.opentact.org/rest/sms/search/inbound?take=10&skip=0', $headers, $data);
import requests
headers = {
'accept': 'application/json',
'X-Auth-Token': 'JWT_TOKEN',
'Content-Type': 'application/json',
}
params = (
('take', '10'),
('skip', '0'),
)
data = '{"take":10,"skip":0,"mode":"AND","order":{"delivered":"ASC"},"created_on_from":"2020-10-27T12:22:07.076Z","created_on_to":"2020-10-27T12:22:07.076Z","modified_on_from":"2020-10-27T12:22:07.076Z","modified_on_to":"2020-10-27T12:22:07.076Z","message":"string","tn":0,"to":"string","from":"string","delivered":true,"readed":true,"state":"created"}'
response = requests.post('https://api.opentact.org/rest/sms/search/inbound', headers=headers, params=params, data=data)
#NB. Original query string below. It seems impossible to parse and
#reproduce query strings 100% accurately so the one below is given
#in case the reproduced version is not "correct".
# response = requests.post('https://api.opentact.org/rest/sms/search/inbound?take=10&skip=0', headers=headers, data=data)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/sms/search/inbound?take=10&skip=0', {
method: 'POST',
headers: {
'accept': 'application/json',
'X-Auth-Token': 'JWT_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({"take":10,"skip":0,"mode":"AND","order":{"delivered":"ASC"},"created_on_from":"2020-10-27T12:22:07.076Z","created_on_to":"2020-10-27T12:22:07.076Z","modified_on_from":"2020-10-27T12:22:07.076Z","modified_on_to":"2020-10-27T12:22:07.076Z","message":"string","tn":0,"to":"string","from":"string","delivered":true,"readed":true,"state":"created"})
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{"take":10,"skip":0,"mode":"AND","order":{"delivered":"ASC"},"created_on_from":"2020-10-27T12:22:07.076Z","created_on_to":"2020-10-27T12:22:07.076Z","modified_on_from":"2020-10-27T12:22:07.076Z","modified_on_to":"2020-10-27T12:22:07.076Z","message":"string","tn":0,"to":"string","from":"string","delivered":true,"readed":true,"state":"created"}`)
req, err := http.NewRequest("POST", "https://api.opentact.org/rest/sms/search/inbound?take=10&skip=0", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-Token", "JWT_TOKEN")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s\n", bodyText)
}
SearchSMS
POST https://api.opentact.org/rest/sms/search
This will search inbound and outbound SMS.
Query Parameters
Name
Type
Description
skip
integer
>= 0 Default: 0
take
integer
[ 1 .. 100 ] Default: 10
Request Body
Name
Type
Description
take
integer
[ 1 .. 100 ] Default: "10" How many items to take
skip
integer
>= 0 Default: "0" How many items to skip
mode
string
(ESearchMode) Enum: "AND" "OR"
order
object
Order items by field's accepted values: · tn · to · message · state · created_on - Default: DESC · modified_on · reference_id · delivered
created_on_from
string
created_on_to
string
modified_on_from
string
<date-time>
modified_on_to
string
<date-time>
message
string
[ 1 .. 918 ] characters Mask Supported
from
string
[ 3 .. 255 ] characters Mask Supported
to
string
[ 3 .. 255 ] characters Mask Supported
delivered
boolean
state
string
Enum: "created" "sending" "sent" "failed"
thread
string
33 characters
{
"success": true,
"payload": {
"total": 0,
"take": 10,
"skip": 0,
"data": []
}
}Code Example
curl -X POST "https://api.opentact.org/rest/sms/search?take=10&skip=0" \
-H "accept: application/json" -H "X-Auth-Token: JWT_TOKEN" \
-H "Content-Type: application/json" \
-d "{\"take\":10,\"skip\":0,\"mode\":\"AND\",\"order\":{},\"created_on_from\":\"2020-10-27T12:38:30.777Z\",\"created_on_to\":\"2020-10-27T12:38:30.777Z\",\"modified_on_from\":\"2020-10-27T12:38:30.777Z\",\"modified_on_to\":\"2020-10-27T12:38:30.777Z\",\"from\":\"string\",\"to\":\"string\",\"thread\":\"string\",\"message\":\"string\",\"delivered\":true,\"state\":\"created\"}"<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
'accept' => 'application/json',
'X-Auth-Token' => 'JWT_TOKEN',
'Content-Type' => 'application/json'
);
$data = '{"take":10,"skip":0,"mode":"AND","order":{},"created_on_from":"2020-10-27T12:38:30.777Z","created_on_to":"2020-10-27T12:38:30.777Z","modified_on_from":"2020-10-27T12:38:30.777Z","modified_on_to":"2020-10-27T12:38:30.777Z","from":"string","to":"string","thread":"string","message":"string","delivered":true,"state":"created"}';
$response = Requests::post('https://api.opentact.org/rest/sms/search?take=10&skip=0', $headers, $data);
import requests
headers = {
'accept': 'application/json',
'X-Auth-Token': 'JWT_TOKEN',
'Content-Type': 'application/json',
}
params = (
('take', '10'),
('skip', '0'),
)
data = '{"take":10,"skip":0,"mode":"AND","order":{},"created_on_from":"2020-10-27T12:38:30.777Z","created_on_to":"2020-10-27T12:38:30.777Z","modified_on_from":"2020-10-27T12:38:30.777Z","modified_on_to":"2020-10-27T12:38:30.777Z","from":"string","to":"string","thread":"string","message":"string","delivered":true,"state":"created"}'
response = requests.post('https://api.opentact.org/rest/sms/search', headers=headers, params=params, data=data)
#NB. Original query string below. It seems impossible to parse and
#reproduce query strings 100% accurately so the one below is given
#in case the reproduced version is not "correct".
# response = requests.post('https://api.opentact.org/rest/sms/search?take=10&skip=0', headers=headers, data=data)
var fetch = require('node-fetch');
fetch('https://api.opentact.org/rest/sms/search?take=10&skip=0', {
method: 'POST',
headers: {
'accept': 'application/json',
'X-Auth-Token': 'JWT_TOKEN',
'Content-Type': 'application/json'
},
body: JSON.stringify({"take":10,"skip":0,"mode":"AND","order":{},"created_on_from":"2020-10-27T12:38:30.777Z","created_on_to":"2020-10-27T12:38:30.777Z","modified_on_from":"2020-10-27T12:38:30.777Z","modified_on_to":"2020-10-27T12:38:30.777Z","from":"string","to":"string","thread":"string","message":"string","delivered":true,"state":"created"})
});
package main
import (
"fmt"
"io/ioutil"
"log"
"net/http"
"strings"
)
func main() {
client := &http.Client{}
var data = strings.NewReader(`{"take":10,"skip":0,"mode":"AND","order":{},"created_on_from":"2020-10-27T12:38:30.777Z","created_on_to":"2020-10-27T12:38:30.777Z","modified_on_from":"2020-10-27T12:38:30.777Z","modified_on_to":"2020-10-27T12:38:30.777Z","from":"string","to":"string","thread":"string","message":"string","delivered":true,"state":"created"}`)
req, err := http.NewRequest("POST", "https://api.opentact.org/rest/sms/search?take=10&skip=0", data)
if err != nil {
log.Fatal(err)
}
req.Header.Set("accept", "application/json")
req.Header.Set("X-Auth-Token", "JWT_TOKEN")
req.Header.Set("Content-Type", "application/json")
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
bodyText, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%s\n", bodyText)
}
Last updated
Was this helpful?