لیست پیام ها
لیست پیام ها
آدرس فراخوانی :
پارامترهای ورودی :
# | فیلد | نام | validations | نوع |
1 | limit | محدودیت | محدودیت بر روی تعداد پیام ها | integer |
2 | order | ترتیب | ترتیب بر اساس کدام فیلد پیام باشد | enum[‘msg_id’, ‘message’, ‘rcpts_count’] |
۳ | orderType | نوع ترتیب | نوع ترتیب از اول به اخر باشد یا برعکس | enum[‘asc’, ‘desc’] |
برای مثال ۲ حالت ارسال در زیر بیان شده است:
json :
{
"limit": "2",
"order": "msg_id",
"orderType": "asc"
}
form-data :
limit:2
order:msg_id
orderType:asc
پاسخ:
json :
{
"success": true,
"data": [
{
"id": 1,
"message": "متن پیام تست یک لغو۱۱",
"time": 998
},
{
"id": 2,
"message": "متن پیام تست دو لغو۱۱",
"time": 999
}
]
}
success
در صورتی که مقدار آن true باشد پاسخ درخواست شما موفقیت آمیز بوده است.
data
حاوی اطلاعات پیام ثبت شده
# | فیلد | نام |
1 | id | شناسه پیام |
2 | message | متن پیام |
۳ | time | زمان ثبت |
نمونه کد
curl –location ‘http://panel.signalads.com/core/rest/api/v1/message/outbox.json’ \
–header ‘Accept: application/json’ \
–header ‘Content-Type: application/json’ \
–header ‘Authorization: Bearer TOKEN’ \
–data ‘{
“limit”: “2”,
“order”: “msg_id”,
“orderType”: “asc”
}’
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘http://panel.signalads.com/core/rest/api/v1/message/outbox.json’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_POSTFIELDS =>'{
“limit”: “2”,
“order”: “msg_id”,
“orderType”: “asc”
}’,
CURLOPT_HTTPHEADER => array(
‘Accept: application/json’,
‘Content-Type: application/json’,
‘Authorization: Bearer TOKEN’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
import http.client
import json
conn = http.client.HTTPSConnection(“panel.signalads.com”)
payload = json.dumps({
“limit”: “2”,
“order”: “msg_id”,
“orderType”: “asc”
})
headers = {
‘Accept’: ‘application/json’,
‘Content-Type’: ‘application/json’,
‘Authorization’: ‘Bearer TOKEN’
}
conn.request(“POST”, “/core/rest/api/v1/message/outbox.json”, payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode(“utf-8”))
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, “http://panel.signalads.com/core/rest/api/v1/message/outbox.json”);
request.Headers.Add(“Accept”, “application/json”);
request.Headers.Add(“Authorization”, “Bearer TOKEN”);
var content = new StringContent(“{\n \”limit\”: \”2\”,\n \”order\”: \”msg_id\”,\n \”orderType\”: \”asc\”\n}”, null, “application/json”);
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
var request = require(‘request’);
var options = {
‘method’: ‘POST’,
‘url’: ‘http://panel.signalads.com/core/rest/api/v1/message/outbox.json’,
‘headers’: {
‘Accept’: ‘application/json’,
‘Content-Type’: ‘application/json’,
‘Authorization’: ‘Bearer TOKEN’
},
body: JSON.stringify({
“limit”: “2”,
“order”: “msg_id”,
“orderType”: “asc”
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse(“application/json”);
RequestBody body = RequestBody.create(mediaType, “{\n \”limit\”: \”2\”,\n \”order\”: \”msg_id\”,\n \”orderType\”: \”asc\”\n}”);
Request request = new Request.Builder()
.url(“https://panel.signalads.com/core/rest/api/v1/message/outbox.json”)
.method(“POST”, body)
.addHeader(“Accept”, “application/json”)
.addHeader(“Content-Type”, “application/json”)
.addHeader(“Authorization”, “Bearer TOKEN”)
.build();
Response response = client.newCall(request).execute();