Latest Legacy

    Retrieve status of number linked to a campaign

    This API lets you fetch the status of a particular number associated with a campaign.

    API Endpoint

    GET https://api.plivo.com/v1/Account/{auth_id}/10dlc/Campaign/{campaign_id}/Number/{number}

    Arguments

    No arguments need to be passed.

    Returns

    The number object for the number & campaign specified in the request URL. Status can take these values: FAILED,PROCESSING,COMPLETED.

    Response

    HTTP Status Code: 200

    {
"api_id": "56df0724-b4a1-11ec-a357-0242ac110002",
"campaign_alias": "ABC Campaign",
"campaign_id": "CUOGHIN",
"phone_numbers": [
{
"number": "14156667777",
"status": "PROCESSING"
}
],
"usecase": "STARTER"
}

    1
2
3
4
5
6
7
8
9
10
11
12
13

    // Available in versions >= 4.30.0 (https://github.com/plivo/plivo-node/releases/tag/v4.30.0)

let plivo = require('plivo');

let client = new plivo.Client('<auth_id>', '<auth_token>');

client.campaign.getNumber("<campaign_id>", "<number>")
    .then(function (response) {
        console.log(JSON.stringify(response));
    }).catch(function (error) {
        console.log("err");
        console.log(error);
    });

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

    <?php

# Available in versions >= 4.29.0 (https://github.com/plivo/plivo-php/releases/tag/v4.29.0)

require '/etc/plivo-php/vendor/autoload.php';
use Plivo\RestClient;

$client = new RestClient("<auth_id>", "<auth_token>");
$client
    ->client
    ->setTimeout(60);
try
{
    $res = $client
        ->campaign
        ->listNumber("<campaign_id>");
    print_r($res);
}
catch(PlivoRestException $ex)
{
    print_r($ex);
}

?>

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

    // Available in versions >= 5.9.0 (https://github.com/plivo/plivo-dotnet/releases/tag/v5.9.0)

using System;
using System.Collections.Generic;
using Plivo;
using Plivo.Exception;

namespace dotnet_project
{
    class Ten_dlc
    {
        static void Main(string[] args)
        {
 
                var api = new PlivoApi("<auth_id>","<auth_token>");

                // Get Number
            Console.WriteLine("Get a Number");
            try
            {   
                    var response = api.Campaign.GetNumber("campaign_id", "<number>");
                    Console.WriteLine(response);
            }
            catch (PlivoRestException e)
            {
                    Console.WriteLine("Exception: " + e.Message);
            }

        }
    }
}

    1
2

    curl -i --user auth_id:auth_token \
    https://api.plivo.com/v1/Account/{auth_id}/10dlc/Campaign/{campaign_id}/Number/14156667778/