Overview

Get singleton instance

The singleton instance of the SenderController class can be accessed from the API Client.

SenderController sender = client.Sender;
SenderController senderController = client.getSender();
Sender* sender  = [[Sender alloc]init]();
SenderController senderController = client.getSender();
$senderController = $client->getSender();
sender_controller = client.sender
sender_controller = client.sender
var app = angular.module('myApp', ['Releans']);
app.controller('testController', SenderController);

function SenderController($scope,
    SenderController) {
}
const lib = require('lib');
const controller = lib.SenderController;

Create Sender Name

Create a new sender id to send messages using it.

POST /sender/create
CreateSenderNameAsync(string senderName)
void createSenderNameAsync(
    final String senderName,
    final APICallBack callBack)
function createSenderNameAsyncWithSenderName:(NSString*) senderName
                completionBlock:(CompletedPostCreateSenderName) onCompleted:(senderName )
void createSenderNameAsync(
    final String senderName,
    final APICallBack callBack)
function createSenderName(
    $senderName)
def create_sender_name(self,
                           sender_name)
def create_sender_name(sender_name)
createSenderName(senderName)
createSenderName(senderName)

Parameter Type Description
senderName
Required
string Name you want to register as Sender Name
Complete File code

Show file for code.

curl -X POST \
  --url 'https://platform.releans.com/api/sender/create' \
  -H 'Authorization: Bearer Your_API_Key' \
  -H 'Content-type: text/plain' \
  --data-raw 'senderName8'
string senderName = "senderName8";

try
{
    string result = sender.CreateSenderNameAsync(senderName).Result;
}
catch (APIException e){};
String senderName = "senderName8";

senderController.createSenderNameAsync(senderName, new APICallBack() {
    public void onSuccess(HttpContext context, String response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});
senderName = @'senderName8';

[sender createSenderNameAsyncWithSenderName: senderName  completionBlock:^(BOOL success, HttpContext* context, NSString* response, NSError* error){
    if(error!=null)
        // Handle error
    else
        NSString* = response;
}];}
String senderName = "senderName8";

senderController.createSenderNameAsync(senderName, new APICallBack() {
    public void onSuccess(HttpContext context, String response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});
$senderName = 'senderName8';

$result = $senderController->createSenderName($senderName);
sender_name = 'senderName8'

result = sender_controller.create_sender_name(sender_name)
sender_name = 'senderName8'

result = sender_controller.create_sender_name(sender_name)
var senderName = 'senderName8';

var result = SenderController.createSenderName(senderName);
result.then(function(response) {
    // this block will be executed on successful endpoint call
    // `response.body` will be of type 'string'
}, function(err) {
    // this block will be executed on endpoint call failure
});
let senderName = 'senderName8';

const promise = controller.createSenderName(senderName);
promise.then((response) => {
    // this block will be executed on successful endpoint call
    // `response` will be of type 'string'
}, (err) => {
    // this block will be executed on endpoint call failure
    // `err` is an 'object' containing more information about the error
});

Get All Senders

List all senders names associated with the account

curl -X GET \
  --url 'https://platform.releans.com/api/sender' \
  -H 'Authorization: Bearer Your_API_Key'\
  -H 'Accept: application/json'
try
{
    dynamic result = sender.GetAllSendersAsync().Result;
}
catch (APIException e){};
senderController.getAllSendersAsync(new APICallBack() {
    public void onSuccess(HttpContext context, DynamicResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});
[sender getAllSendersWithCompletionBlock:  ^(BOOL success, HttpContext* context, id response, NSError* error){
    if(error!=null)
        // Handle error
    else
        id = response;
}];}
senderController.getAllSendersAsync(new APICallBack() {
    public void onSuccess(HttpContext context, DynamicResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});
$result = $senderController->getAllSenders();
result = sender_controller.get_all_senders()
result = sender_controller.get_all_senders()
var result = SenderController.getAllSenders();
result.then(function(response) {
    // this block will be executed on successful endpoint call
    // `response.body` will be of type 'mixed'
}, function(err) {
    // this block will be executed on endpoint call failure
});
const promise = controller.getAllSenders();
promise.then((response) => {
    // this block will be executed on successful endpoint call
    // `response` will be of type 'mixed'
}, (err) => {
    // this block will be executed on endpoint call failure
    // `err` is an 'object' containing more information about the error
});

Get Sender Name Details

Return the details of the sender name.

curl -X GET -G \
  --url 'https://platform.releans.com/api/sender/view/' \
  -H 'Authorization: Bearer Your_API_Key'\
  -H 'Accept: application/json' \
  -d 'id=id0'
string id = "id0";

try
{
    dynamic result = sender.GetSenderNameDetailsAsync(id).Result;
}
catch (APIException e){};
String id = "id0";

senderController.getSenderNameDetailsAsync(id, new APICallBack() {
    public void onSuccess(HttpContext context, DynamicResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});
mid = @'id0';

[sender getSenderNameDetailsAsyncWithId: mid  completionBlock:^(BOOL success, HttpContext* context, id response, NSError* error){
    if(error!=null)
        // Handle error
    else
        id = response;
}];}
String id = "id0";

senderController.getSenderNameDetailsAsync(id, new APICallBack() {
    public void onSuccess(HttpContext context, DynamicResponse response) {
        // TODO success callback handler
    }
    public void onFailure(HttpContext context, Throwable error) {
        // TODO failure callback handler
    }
});
$id = 'id0';

$result = $senderController->getSenderNameDetails($id);
id = 'id0'

result = sender_controller.get_sender_name_details(id)
id = 'id0'

result = sender_controller.get_sender_name_details(id)
var id = 'id0';

var result = SenderController.getSenderNameDetails(id);
result.then(function(response) {
    // this block will be executed on successful endpoint call
    // `response.body` will be of type 'mixed'
}, function(err) {
    // this block will be executed on endpoint call failure
});
let id = 'id0';

const promise = controller.getSenderNameDetails(id);
promise.then((response) => {
    // this block will be executed on successful endpoint call
    // `response` will be of type 'mixed'
}, (err) => {
    // this block will be executed on endpoint call failure
    // `err` is an 'object' containing more information about the error
});

Parameter Type Description
id
Required
string The sender id you want its details.