Sender ID

Alphanumeric Sender ID allows you to send Releans SMS messages from a personalized sender name (rather than using your Releans shared phone number) in supported countries. Instead of using an E.164 formatted Releans Shared Phone number for the "From" value, you can use a custom text string like your company's name.

Alphanumeric Sender ID works on single text messages, as well as with SMS Campaigns.

New Sender ID

Alphanumeric Sender ID is automatically supported on all Releans accounts.

What characters can I use in my Alphanumeric Sender ID?

Alphanumeric Sender ID supports up to 11 characters from the following categories:

Upper-case letters A-Z
Lower-case letters a-z
Numbers 0-9
Spaces

Your ID must include at least three letters; It cannot be comprised of only numbers. Non-ASCII special characters and punctuation are not allowed.

Good to know the parameters before

Parameter Type Description
senderName
Required 		string Sender ID can be a maximum length of 11 characters

POST Request


                            
<?php
$curl = curl_init();
            
curl_setopt_array($curl, array(
     CURLOPT_URL => "https://api.releans.com/v2/sender",
     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 => "SenderName=Company",
     CURLOPT_HTTPHEADER => array(
          "Authorization: Bearer Your_API_Key"
     ),
));
            
$response = curl_exec($curl);
            
curl_close($curl);
echo $response;

Update Sender ID

Update your current Sender ID and modify your Sender spelling. Use this endpoint carefully.

PUT Request


                            
<?php
$curl = curl_init();
            
curl_setopt_array($curl, array(
     CURLOPT_URL => "https://api.releans.com/v2/sender",
     CURLOPT_RETURNTRANSFER => true,
     CURLOPT_ENCODING => "",
     CURLOPT_MAXREDIRS => 10,
     CURLOPT_TIMEOUT => 0,
     CURLOPT_FOLLOWLOCATION => true,
     CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
     CURLOPT_CUSTOMREQUEST => "PUT",
     CURLOPT_POSTFIELDS => "id=SENDER_ID&SenderName=Company",
     CURLOPT_HTTPHEADER => array(
          "Authorization: Bearer Your_API_Key"
     ),
));
            
$response = curl_exec($curl);
            
curl_close($curl);
echo $response;

Delete Sender ID

Delete a specific sender id.

DEL Request


                            
<?php
$curl = curl_init();
            
curl_setopt_array($curl, array(
     CURLOPT_URL => "https://api.releans.com/v2/sender",
     CURLOPT_RETURNTRANSFER => true,
     CURLOPT_ENCODING => "",
     CURLOPT_MAXREDIRS => 10,
     CURLOPT_TIMEOUT => 0,
     CURLOPT_FOLLOWLOCATION => true,
     CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
     CURLOPT_CUSTOMREQUEST => "DELETE",
     CURLOPT_POSTFIELDS => "id=SENDER_ID",
     CURLOPT_HTTPHEADER => array(
          "Authorization: Bearer Your_API_Key"
     ),
));
            
$response = curl_exec($curl);
            
curl_close($curl);
echo $response;

Retrieve Sender ID

Retrieve Sender ID details with its status, and id.

GET Request


                            
<?php
$curl = curl_init();
            
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.releans.com/v2/sender?id=SENDER_ID",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
                "Authorization: Bearer Your_API_Key"
         ),
));
            
$response = curl_exec($curl);
            
curl_close($curl);
echo $response;

Retrieve All Senders

Retrieve all your Sender IDs details with its status, and id.

GET Request


                            
<?php
$curl = curl_init();
            
curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.releans.com/v2/sender",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
                "Authorization: Bearer Your_API_Key"
         ),
));
            
$response = curl_exec($curl);
            
curl_close($curl);
echo $response;