Overview and parameters

HTTP based API will be used as Inbox listener through TeleOSS.

Input Parameter Description:

Parameter Value (Sample) Required Description
code 4545 Mandatory Short code or Long Code
message TEST SMS Mandatory Content sent by end user
sender 888XXXX455 Mandatory End user mobile number

Error Codes:

Sr No Error Code Error Status
1 -101 Unknown
2 000 Success
3 001 Required
4 002 Invalid
5 003 Failed
6 004 Duplicate

Request reference

Request

POST https://{Domain}/client/api/inbox/receive/*

Code examples

Code example 
curl --location --request POST 'https://{Domain}/client/api/inbox/receive/*'
const url = "https://{Domain}/client/api/inbox/receive/*";
const options = {
  method: "POST"
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);
import requests

url = "https://{Domain}/client/api/inbox/receive/*"
headers = {}

response = requests.request(
    "POST",
    url,
    headers=headers
)
print(response.json())
<?php
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://{Domain}/client/api/inbox/receive/*",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST"
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

Response example

JSON response
{
"status": {
"error-code": "",
"error-status": "",
"error-description": ""
},
"inbox-detail": {
"inbox-id": ""
}
}