Send an SMS campaign's report

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 sendReport = new SibApiV3Sdk.SendReport();

sendReport = {
    language: 'string',
    email: {
        'to': ['[email protected]']
    }
}

apiInstance.sendSmsReport(campaignId, sendReport).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;
$sendReport = new \SendinBlue\Client\Model\SendReport();
$sendReport['language'] = 'en';
$sendReport['email'] = array(
    'to' => array('[email protected]'),
  'contentType' => 'html',
  'subject' => 'New Subject',
  'body' => '<html><body><h1>This is my first campaign</h1></body></html>'
); 

try {
    $apiInstance->sendSmsReport($campaignId, $sendReport);
} catch (Exception $e) {
    echo 'Exception when calling SMSCampaignsApi->sendSmsReport: ', $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
send_report = sib_api_v3_sdk.SendReport(language="string", email="string)

try:
    api_response = api_instance.send_sms_report(campaign_id, send_report)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SMSCampaignsApi->send_sms_report: %s\n" % e)

<?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;
$sendReport = new \SendinBlue\Client\Model\SendReport();
$sendReport['language'] = 'en';
$sendReport['email'] = array(
    'to' => array('[email protected]'),
  'contentType' => 'html',
  'subject' => 'New Subject',
  'body' => '<html><body><h1>This is my first campaign</h1></body></html>'
); 

try {
    $apiInstance->sendSmsReport($campaignId, $sendReport);
} catch (Exception $e) {
    echo 'Exception when calling SMSCampaignsApi->sendSmsReport: ', $e->getMessage(), PHP_EOL;
}
?>

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;
            SendReport.LanguageEnum language = SendReport.LanguageEnum.En;
            List<string> to = new List<string>();
            to.Add("[email protected]");
            string body = "<html><body><h1>This is my first campaign</h1></body></html>";
            try
            {
                SendReportEmail email = new SendReportEmail(to, body);
                var sendReport = new SendReport(language, email);
                apiInstance.SendSmsReport(campaignId, sendReport);
                Console.ReadLine();
            }
            catch (Exception e)
            {
                Debug.WriteLine(e.Message);
                Console.WriteLine(e.Message);
                Console.ReadLine();
            }
        }
    }
}

# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
  # Configure API key authorization: api-key
  config.api_key['api-key'] = 'YOUR API KEY'
end

api_instance = SibApiV3Sdk::SMSCampaignsApi.new

campaign_id = 789 # Integer | id of the campaign

send_report = SibApiV3Sdk::SendReport.new # SendReport | Values for send a report

send_report = {
  'language'=> 'string',
  'email'=> {
    'to'=> ['[email protected]']
  }
}

begin
  #Send an SMS campaign's report
  api_instance.send_sms_report(campaign_id, send_report)
rescue SibApiV3Sdk::ApiError => e
  puts "Exception when calling SMSCampaignsApi->send_sms_report: #{e}"
end