Documentations
Outbox API Documentations
Send Message to Recipient
POST
https://outbox.rest/send/message
Service to be used to send messages to members.
Headers
Content-Type
string
application/json
Request Body
Unique
string
OFF / ON (default = ON)
Recipients
array
"Recipients":[
{ "Recipient": "+90555xxxx",
"Content": "Merhaba /*AD*/ ,
"Variables": { "AD": "Test" }
},]
MessageID
string
Campaign number defined in our system
When
string
Sent on a spesific date Ex."2045-12-21 23:59:59"
Priority
string
NORMAL/FAST/TEST/SIMULATION
SendAlwyays
integer
0/1/2
MessageType
string
SMS/MMS/EMAIL
AuthKey
string
Authentication token for using API
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
Get Status of Sent Message
POST
https://outbox.rest/get/status
Service to query the status of a sent message on a member basis.
Headers
Content-Type
string
application/json
Request Body
TrackingID
string
The person-based TrackingID number after sending a message
Language
string
EN/TR
AuthKey
string
Authentication token for using API
Language
Determine language of the result.
Create Group
POST
https://outbox.rest/create/group
Service used to create groups/list .
Headers
Content-Type
string
application/json
Request Body
AutheKey
string
Authentication token for using API
GroupName
string
The given name will be used as the group name
Group Info
POST
https://outbox.rest/info/group
Service used to get information about the group/list.
Headers
Content-Type
string
application/json
Request Body
GroupID
integer
Group ID
AuthKey
string
Authentication token for using API
Add Recipient to Group
POST
https://outbox.rest/add/group/recipient
Service used to add members to any group/list.
Headers
Content-Type
string
application/json
Request Body
WaitResponse
boolean
Wait for Response (default = True)
Recipients
array
example:
[
{
"EMail": "test@test.com",
"GSMTel1": "5555555555"
}
]
*Email is required.
GroupID
integer
The given ID will be used as the group ID
AuthKey
string
Authentication token for using API
Recipient
Permit
Used to specify permissions for adding contacts to a group. **Optional
Remove Recipient From Group
POST
https://outbox.rest/recipient/update/status
Service used to remove the member from the group/list.
Headers
Content-Type
string
application/json
Request Body
Type
string
BLOCK/UNBLOCK/SUBSCRIBE/UNSUBSCRIBE CORRECT/INCORRECT
Recipient
string
Person's mail address
AuthKey
string
Authentication token for using API
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.
Send Message to Group
POST
https://outbox.rest/send/group/message
Service used to send message to group/list
Headers
Content-Type
string
application/json
Request Body
GroupID
integer
if not added default group to be selected
MessageID
integer
The id of the message from panel
AuthKey
string
Authentication token for using API
Message Info
POST
https://outbox.rest/info/message
Service used to query the status of a sent message.
Headers
Content-Type
string
application/json
Request Body
Details
boolean
if it is true, the result is a more detailed list. default contains global values.
EndDate
string
End Date for result ("yyyy-mm-dd")
StartDate
string
Start Date for result ("yyyy-mm-dd")
SenderName
string
Sender name
MessageID
integer
The id of the previously sent message
AuthKey
string
Authentication token for using API
Groups
GET
https://outbox.rest/groups
Service used to get detailed information about all groups/list.
Headers
AuthKey
string
Authentication token for using API
Group Recipients
POST
https://outbox.rest/group/recipients
Service used to query the group-based member.
Headers
Content-Type
string
application/json
Request Body
Date
string
Date is user added date. Key format YYY-MM-DD
Page
number
Page number
Limit
number
Default value 100, Maximum value 500
GroupID
integer
Group ID
AuthKey
string
Authentication token for using API
Get Recipient
POST
https://outbox.rest/get/recipient
Service used for member-based inquiry.
Headers
Content-Type
string
application/json
Request Body
integer
Recipient email address
uniqueID
string
When creating a recipient, unique id is given to recipient
ContactNo
integer
ContactNo after added recipient
AuthKey
string
Authentication token for using API
uniqueID
Special identification number sent from your system when adding a recipient
ContactID
Spesific id sent after adding recipients
Get Recipients with Status
POST
https://outbox.rest/status/recipients
Service based on two dates between status of the member to query Ex. 01.01.2019-01.02.2019 between dates of leaving the membership
Headers
Contet-Type
string
application/json
Request Body
Count
string
Page size limit
EndDate
string
Query Date Finish (yyyy-mm-dd)
StartDate
string
Query Date Start (yyyy-mm-dd)
Page
number
Page number (default '1' )
Type
string
READERS/MYREADER/ CLICKERS/MYCLIKERS/ VALID/BOUNCED/COMPLAINED/ BLOCKS/BLOCKED/ INVALID/ALL
GroupID
integer
GroupID
AuthKey
string
Authentication token for using API
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
Send Message to Recipient (XML)
POST
https://outbox.rest/send/xml/message
Send Message API with XML
Headers
Content-Type
string
application/xml
Get Status of Sent Message (XML)
POST
https://outbox.rest/get/xml/status
Get Status API with XML
Path Parameters
Content-Type
string
application/xml
Update Status Message
GET
https://outbox.rest/update/status/message
Update status to message
Headers
Content-Type
string
application/json
Request Body
Type
string
ON/STOP/PAUSE
MessageID
string
MessageID for update status
AuthKey
string
Authentication token for using API
Last updated
Was this helpful?