Export an SMS campaign's recipients

It returns the background process ID which on completion calls the notify URL that you have set in the input.

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 opts = {
  'recipientExport': new SibApiV3Sdk.RequestSmsRecipientExport()
};

opts.recipientExport = {
    notifyURL = 'https://example.com/notifyurl',
    recipientsType = 'string'
}

apiInstance.requestSmsRecipientExport(campaignId, opts).then(function(data) {
    console.log('API called successfully. Returned data: ' + JSON.stringify(data));
}, 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;
$recipientExport = new \SendinBlue\Client\Model\RequestSmsRecipientExport();
$recipientExport['notifyUrl'] = 'https://example.com/notifyurl';
$recipientExport['recipientsType'] = 'all';

try {
    $result = $apiInstance->requestSmsRecipientExport($campaignId, $recipientExport);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSCampaignsApi->requestSmsRecipientExport: ', $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
recipient_export = sib_api_v3_sdk.RequestSmsRecipientExport(notify_url="https://example.com/notifyurl", recipients_type="string")

try:
    api_response = api_instance.request_sms_recipient_export(campaign_id, recipient_export=recipient_export)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SMSCampaignsApi->request_sms_recipient_export: %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 recipientExport = new SibApiV3Sdk.RequestSmsRecipientExport();

recipientExport.notifyURL = 'https://example.com/notifyurl';
recipientExport.recipientsType = 'all';

apiInstance.requestSmsRecipientExport(campaignId).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 notifyUrl = "https://example.com/notifyurl";
            RequestSmsRecipientExport.RecipientsTypeEnum recipientsType = RequestSmsRecipientExport.RecipientsTypeEnum.All;
            try
            {
                var recipientExport = new RequestSmsRecipientExport(notifyUrl, recipientsType);
                CreatedProcessId result = apiInstance.RequestSmsRecipientExport(campaignId, recipientExport);
                Debug.WriteLine(result.ToJson());
                Console.WriteLine(result.ToJson());
                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!