Send a test SMS campaign

Code Examples

You can use as reference the code below to implement this call in your preferred language.
Check all our official API clients here

const SibApiV3Sdk = require('sib-api-v3-sdk');
const defaultClient = SibApiV3Sdk.ApiClient.instance;

let apiKey = defaultClient.authentications['api-key'];
apiKey.apiKey = 'YOUR API KEY';

let apiInstance = new SibApiV3Sdk.SMSCampaignsApi();

let campaignId = 1;

let phoneNumber = new SibApiV3Sdk.SendTestSms();

phoneNumber.phoneNumber = 'string';

apiInstance.sendTestSms(campaignId, phoneNumber).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$config = SendinBlue\Client\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR API KEY');

$apiInstance = new SendinBlue\Client\Api\SMSCampaignsApi(
    new GuzzleHttp\Client(),
    $config
);
$campaignId = 1;
$phoneNumber = new \SendinBlue\Client\Model\SendTestSms();
$phoneNumber['phoneNumber'] = '+3312356789';

try {
    $apiInstance->sendTestSms($campaignId, $phoneNumber);
} catch (Exception $e) {
    echo 'Exception when calling SMSCampaignsApi->sendTestSms: ', $e->getMessage(), PHP_EOL;
}
?>
from __future__ import print_function
import time
import sib_api_v3_sdk
from sib_api_v3_sdk.rest import ApiException
from pprint import pprint

configuration = sib_api_v3_sdk.Configuration()
configuration.api_key['api-key'] = 'YOUR API KEY'

api_instance = sib_api_v3_sdk.SMSCampaignsApi(sib_api_v3_sdk.ApiClient(configuration))
campaign_id = 1
phone_number = sib_api_v3_sdk.SendTestSms(phone_number="string")

try:
    api_response = api_instance.send_test_sms(campaign_id, phone_number)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SMSCampaignsApi->send_test_sms: %s\n" % e)
const SibApiV3Sdk = require('sib-api-v3-typescript');
 
let apiInstance = new SibApiV3Sdk.SMSCampaignsApi()

let apiKey = apiInstance.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';

let campaignId = 1;

let phoneNumber = new SibApiV3Sdk.SendTestSms();
phoneNumber.phoneNumber = '+3312356789';

apiInstance.sendTestSms(campaignId, phoneNumber).then(function(data) {
  console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, function(error) {
  console.error(error);
});
using sib_api_v3_sdk.Api;
using sib_api_v3_sdk.Client;
using sib_api_v3_sdk.Model;
using System;
using System.Collections.Generic;
using System.Diagnostics;

namespace Sendinblue
{
    class Program
    {
        static void Main(string[] args)
        {
            Configuration.Default.ApiKey.Add("api-key", "YOUR API KEY");

            var apiInstance = new SMSCampaignsApi();
            long? campaignId = 1;
            string number = "+3312356789";
            try
            {
                var phoneNumber = new SendTestSms(number);
                apiInstance.SendTestSms(campaignId, phoneNumber);
                Console.ReadLine();
            }
            catch (Exception e)
            {
                Debug.WriteLine(e.Message);
                Console.WriteLine(e.Message);
                Console.ReadLine();
            }
        }
    }
}
Language
Authentication
Header
Response
Click Try It! to start a request and see the response here!