Latest Legacy

Retrieve a specific brand

This API lets you fetch details about a specific brand associated to your account.

API Endpoint

GET https://api.plivo.com/v1/Account/{auth_id}/Brand/{brand_id}/

Arguments

No arguments need to be passed.

Returns

api_id and the brand object identified by the brand_id specified in the request URL.

Response

HTTP Status Code: 200

{'api_id': '0215c238-1701-11ed-9d48-0242ac110003',
'brand': {'address': {'city': 'New York',
'country': 'IN',
'postal_code': '10001',
'state': 'NY',
'street': '123'},
'authorized_contact': {'email': 'test@plivo.com',
'first_name': 'John',
'last_name': 'Doe',
'phone': '1890342302',
'seniority': 'admin',
'title': 'Doe'},
'brand_id': 'BVMN1EM',
'brand_type': 'STARTER',
'ein_issuing_country': 'IN',
'entity_type': 'PRIVATE',
'profile_uuid': 'dd0b418d-73df-4eb4-a7ab-171b774bf4a9',
'registration_status': 'COMPLETED',
'vertical': 'ENERGY',
'website': 'www.google.com'}}

Example Request 

1
2
3
4
5
6
7

import sys
sys.path.append("../plivo-python")
import plivo

client = plivo.RestClient("<auth_id>", "<auth_token>")
response = client.campaign.list(limit=1, offset=0)
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 Brand
	puts('Get Brand')
	response = api.brand.get("<Brand_ID>")

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

1
2
3
4
5
6
7
8
9
10

let plivo = require('plivo');

let client = new plivo.Client("<auth_id>", "<auth_token>");
client.brand.get("<brand_id>")
    .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

<?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
        ->brand
        ->get("<brand_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

package com.plivo.examples;

import com.plivo.api.Plivo;
import com.plivo.api.models.brand.Brand;

public class PlivoTest {

    public static void main(String[] args) {

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

        // Get Brand Details
        try {
            Brand response = Brand.getter("<Brand_ID>").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

// 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 Brand
            Console.WriteLine("Get Brand");
            try
            {
                var response = api.Brand.Get("B8OD95Z");
                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/Brand/{brand_id}/  

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/v7"
)

func main() {
        client, err := plivo.NewClient("<auth_id>", "<auth_token>", &plivo.ClientOptions{})
        if err != nil {
                panic(err)
        }
        //List Brands
        response, err := client.Brand.List(plivo.BrandListParams{Limit: 1, Offset: 0})
        if err != nil {
                fmt.Printf("Error occurred while getting brands. error:%+v\n", err)
                os.Exit(1)
        } else {
                fmt.Printf("%+v\n", response)
        }
}