مستندات نجوا

_

apiV1NotificationsPost

از این API‌ برای ارسال نوتیفیکیشن برای تمامی اعضای یک و‌ب‌سایت یا اپلیکیشن خود می‌توانید استفاده کنید. در این API‌می‌توانید کاربران خود را با توجه به سگمنت‌هایی که در پنل نجوای خود ساخته‌اید، فیلتر کنید. همچنین می‌توانید کاربران اکانت onesignal‌خود را که در پنل نجوا وارد کرده‌اید نیز به جمع دریافت‌کنندگان نوتیفیکیشن ارسالی اضافه کنید.


/api/v1/notifications

Usage and SDK Samples

curl -X POST "https://api.apieco.ir/najva/api/v1/notifications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api._Api;

import java.io.File;
import java.util.*;

public class _ApiExample {

    public static void main(String[] args) {
        
        _Api apiInstance = new _Api();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String authorization = authorization_example; // String | Token ""
        Body body = ; // Body | 
        try {
            apiInstance.apiV1NotificationsPost(apiecoKey, authorization, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling _Api#apiV1NotificationsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api._Api;

public class _ApiExample {

    public static void main(String[] args) {
        _Api apiInstance = new _Api();
        String apiecoKey = apiecoKey_example; // String | apikey for use API
        String authorization = authorization_example; // String | Token ""
        Body body = ; // Body | 
        try {
            apiInstance.apiV1NotificationsPost(apiecoKey, authorization, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling _Api#apiV1NotificationsPost");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
String *authorization = authorization_example; // Token "" (default to Token "")
Body *body = ; //  (optional)

_Api *apiInstance = [[_Api alloc] init];

[apiInstance apiV1NotificationsPostWith:apiecoKey
    authorization:authorization
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var _ = require('_');

var api = new _._Api()

var apiecoKey = apiecoKey_example; // {String} apikey for use API

var authorization = authorization_example; // {String} Token ""

var opts = { 
  'body':  // {Body} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiV1NotificationsPost(apiecoKey, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class apiV1NotificationsPostExample
    {
        public void main()
        {
            
            var apiInstance = new _Api();
            var apiecoKey = apiecoKey_example;  // String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
            var authorization = authorization_example;  // String | Token "" (default to Token "")
            var body = new Body(); // Body |  (optional) 

            try
            {
                apiInstance.apiV1NotificationsPost(apiecoKey, authorization, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling _Api.apiV1NotificationsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\_Api();
$apiecoKey = apiecoKey_example; // String | apikey for use API
$authorization = authorization_example; // String | Token ""
$body = ; // Body | 

try {
    $api_instance->apiV1NotificationsPost($apiecoKey, $authorization, $body);
} catch (Exception $e) {
    echo 'Exception when calling _Api->apiV1NotificationsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::_Api;

my $api_instance = WWW::SwaggerClient::_Api->new();
my $apiecoKey = apiecoKey_example; # String | apikey for use API
my $authorization = authorization_example; # String | Token ""
my $body = WWW::SwaggerClient::Object::Body->new(); # Body | 

eval { 
    $api_instance->apiV1NotificationsPost(apiecoKey => $apiecoKey, authorization => $authorization, body => $body);
};
if ($@) {
    warn "Exception when calling _Api->apiV1NotificationsPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client._Api()
apiecoKey = apiecoKey_example # String | apikey for use API (default to WsLdHK46I5Wfr5xgI0ynjjyiw9Fyhydu)
authorization = authorization_example # String | Token "" (default to Token "")
body =  # Body |  (optional)

try: 
    api_instance.api_v1_notifications_post(apiecoKey, authorization, body=body)
except ApiException as e:
    print("Exception when calling _Api->apiV1NotificationsPost: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
apikey for use API
Required
Authorization*
String
Token "<YOUR_TOKEN>"
Required
Body parameters
Name Description
body

Responses

Status: 201 - { “detail”: “notification created successfully!” }

Status: 401 - { “detail”: “unauthorized” }

Status: 403 - { “detail”: “you are not owner of this website” }

Status: 404 - { “detail”: “user with this Token does not exists” }