Documentations
Outbox API Documentations
post
https://outbox.rest
/send/message
Send Message to Recipient
Recipients
Reference
You may use tour own single and unique tracking id you generate for each message, and you may follow delivery results with your won tracking id
Attachment
Allowed types
  • MMS: 3GP, PDF, CSV, DOC, XLS, TXT, MP3, MP4, ICS
  • EMAIL: PPT
  • IMAGE: JPG, JPEG, GIF, BMP, PNG
Variables
Variables for dynamic contents
Priority
  • NORMAL
  • FAST: Deliver fast, prioritize delivery
  • TEST: Treat message as a test message and update CDN and source files
  • SIMULATION : Send message as simulation
SendAlways
  • 0: Obey activity filters defined in the system
  • 1: Send normal, skip activity filters
  • 2: Force to send
Unique
In the same time zone, sending messages to the same person is blocked by the system. You can change it with Unique Key.
ON
Enabled
OFF
Disabled
Default
Enabled

Send Message Javascript/AJAX example
var responseData = {
"AuthKey": "**********************",
"MessageType": "SMS",
"Recipients": [
{
"Recipient": "+905326124837",
"Content": "Merhaba /*Ad*/",
"Variables": {
"Ad": "Aycan"
}
},
{
"Recipient": "+905398836180",
"Content": "Merhaba /*Ad*/",
"Variables": {
"Ad": "Abdullah"
}
}
],
"SendAlways": 2,
"Priority": "FAST",
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/send/message",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/get/status
Get Status of Sent Message
Language
Determine language of the result.
Get Status Javascript/AJAX example
var responseData = {
"AuthKey": "***********************",
"Language": "EN",
"TrackingID": "********************"
}
var settings = {
"async": true,
"crossDomain": true,
"url": "https://outbox.rest/get/status",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/create/group
Create Group
Create Group Javascript/AJAX example
var responseData = {
"AuthKey": "***********************",
"GroupName": "test group-1"
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/create/group",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/info/group
Group Info
Group Info Javascript/AJAX example
var responseData = {
"AuthKey": "***********************",
"GroupID":"10"
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/info/group",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/add/group/recipient
Add Recipient to Group
Recipient
Permit
Used to specify permissions for adding contacts to a group. **Optional
Add Recipient Javascript/AJAX example
var responseData = {
"AuthKey": "**********************",
"GroupID": 15,
"Recipients": [
{
"EMail": "[email protected]",
"GSMTel1": "5011231231",
"FirstName": "adad",
"LastName": "adasdasd",
"DateOfBirth": "1900-01-01",
"City": "",
"Gender": "0",
"Permit": {
"Email": true,
"GSM": false,
"Push": false
}
}
]
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/add/group/recipient",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/recipient/update/status
Remove Recipient From Group
Type
BLOCK
Block the recipient from within the group.
UNBLOCK
Unblock the recipient from within the group.
SUBSCRIBE
Subscribe the recipient from within the group.
UNSUBSCRIBE
Unsubscribe the recipient from within the group.
CORRECT
Correct the recipient from within the group.
INCORRECT
Incorrect the recipient from within the group.
Recipient Update Status Javascript/AJAX example
var responseData = {
"AuthKey": "******************",
"EMail":"[email protected]",
"Type":"SUBSCRIBE"
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/recipient/update/status",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/send/group/message
Send Message to Group
Send message to group Javascript/AJAX example
var responseData = {
"AuthKey": "**********************",
"GroupID": 10,
"MessageID":5
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/send/group/message",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/info/message
Message Info
Message Info Javascript/AJAX example
var responseData = {
"AuthKey": "**********************",
"MessageID":5
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/send/group/message",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
get
https://outbox.rest
/groups
Groups
Groups Javascript/AJAX example
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/groups",
"method": "GET",
"headers": {
"Content-Type": "application/json",
"AuthKey": "**********************",
},
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/group/recipients
Group Recipients
Group Recipients Javascript/AJAX example
var responseData = {
"AuthKey": "**********************",
"GroupID":10
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/group/recipients",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/get/recipient
Get Recipient
uniqueID or ContactID ---> You have to send one of the two.
uniqueID
Special identification number sent from your system when adding a recipient
ContactID
Spesific id sent after adding recipients
Get Recipient Javascript/AJAX example
var responseData = {
"AuthKdey": "*********************",
"uniqueID":329,
"GroupID":10
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/get/recipient",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
post
https://outbox.rest
/status/recipients
Get Recipients with Status
*The number of pages varies depending on the key sent with the Count key.
Type
MYREADERS
Include people who have seen the messages before
READERS
Show the recipients frequently seen in the group
CLICKERS
Include people who have click the messages before
MYCLICKERS
Show the recipients frequently click in the group
VALID
Show valid recipients in group.
BOUNCED
Show extracted recipients.
COMPLAINED
Show complaining recipients.
BLOCKS
Show blocked recipients in all groups.
BLOCKED
Show blocked recipients in group.
INVALID
Show invalid recipients in group.
ALL
all recipients
Status Recipients Javascript/AJAX example
var responseData = {
"AuthKey": "*************************",
"Type":"ALL",
"GroupID":10,
"Count":20,
"Page":2,
"StartDate":"2018-01-01",
"EndDate":"2018-12-30"
}
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/status/recipients",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});c
post
https://outbox.rest
/send/xml/message
Send Message to Recipient (XML)
Send Message XML example
<?xml version="1.0" encoding="UTF-8"?>
<data>
<AuthKey>***********************</AuthKey>
<MessageType>SMS</MessageType>
<Priority>NORMAL</Priority>
<MessageID>15</MessageID>
<Recipients>
<SenderName>Test</SenderName>
<Content>test</Content>
<Recipient>+9053xxxxxxxx</Recipient>
</Recipients>
<SendAlways>2</SendAlways>
</data>
post
https://outbox.rest
/get/xml/status
Get Status of Sent Message (XML)
Get Status XML example
<?xml version="1.0" encoding="UTF-8"?>
<data>
<AuthKey>****************************</AuthKey>
<Language>EN</Language>
<TrackingID>d3d54b027b674e2abd98fea967238908</TrackingID>
</data>
get
https://outbox.rest
/update/status/message
Update Status Message
var responseData = {
"AuthKey": "*************************",
"Type":"ON",
"MessageID":12345
}
/*
ON = Start Message
STOP = Stop Message
PAUSE = Pause Message
*/
var settings = {
"async": true,
"crossDomain": true,
"url": "http://outbox.rest/update/status/message",
"method": "POST",
"headers": {
"Content-Type": "application/json",
},
"processData": false,
"data": JSON.stringify(responseData)
}
$.ajax(settings).done(function (response) {
console.log(response);
});
Last modified 1yr ago
Copy link
On this page
post
Send Message to Recipient
post
Get Status of Sent Message
post
Create Group
post
Group Info
post
Add Recipient to Group
post
Remove Recipient From Group
post
Send Message to Group
post
Message Info
get
Groups
post
Group Recipients
post
Get Recipient
post
Get Recipients with Status
post
Send Message to Recipient (XML)
post
Get Status of Sent Message (XML)
get
Update Status Message