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 and campaign specified in the request URL. Status can take the 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": "12125557777",
"status": "PROCESSING"
}
],
"usecase": "STARTER"
}

Example Request 

1
2
3
4
5
6
7

import plivo

client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.get_number(
    campaign_id="<Campaign_ID>", number="<phone_number>"
)
print(response)

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

require "rubygems"
require "/etc/plivo-ruby/lib/plivo.rb"
include Plivo

api = RestClient.new("<auth_id>", "<auth_token>")

begin
	# Get Campaign Number
	puts('Get Campaign Number')
	response = api.campaign.get_number("<Campaign_ID>","<phone_ number>")

	puts response
rescue PlivoRESTError => e
	puts 'Exception: ' + e.message
end

1
2
3
4
5
6
7
8
9
10
11

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

package com.plivo.examples;

import com.plivo.api.Plivo;
import com.plivo.api.models.campaign.CampaignNumbers;

public class PlivoTest {

    public static void main(String[] args) {

        Plivo.init("<auth_id>", "<auth_token>");

        // Get Campaign Number Detail
        try {
            CampaignNumbers response = CampaignNumbers.getNumber("<Campaign_ID>")
                .number("<number>").get();
            System.out.println(response);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

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/12025551111/

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

package main

import (
	"fmt"
	"os"

	plivo "github.com/plivo/plivo-go"
)

func main() {
	client, err := plivo.NewClient("<auth_id>", "<auth_token>", &plivo.ClientOptions{})
	if err != nil {
		panic(err)
	}
	//Get Campaign Number
	response, err := client.Campaign.NumberGet("<Campaign_ID>", "<phone_ number>")
	if err != nil {
		fmt.Printf("Error occurred while getting number detail. error:%+v\n", err)
		os.Exit(1)
	} else {
		fmt.Printf("%+v\n", response)
	}
}