Search SMS
SearchOutboundSMS
POST
https://api.opentact.org/rest/sms/search/outbound
This will search all outbound SMS.
Query Parameters
skip
integer
>= 0 Default: 0
take
integer
[ 1 .. 100 ] Default: 10
Headers
Content-Type
string
application/json
Authorization
string
JWT or Bearer
Request Body
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\"}"
SearchInboundSMS
POST
https://api.opentact.org/rest/sms/search/inbound
This will search all inbound SMS.
Query Parameters
skip
integer
>= 0 Default: 0
take
integer
[ 1 .. 100 ] Default: 10
Request Body
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\"}"
SearchSMS
POST
https://api.opentact.org/rest/sms/search
This will search inbound and outbound SMS.
Query Parameters
skip
integer
>= 0 Default: 0
take
integer
[ 1 .. 100 ] Default: 10
Request Body
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\"}"
Last updated
Was this helpful?