Render the BPO Authorization LOA for a DIR

The Letter of Authorization in which a Brand Owner authorizes an approved BPO (Business Process Outsourcer) to place branded calls that display this DIR on the owner’s behalf. Both parties are read from the caller’s account: the Brand Owner is the enterprise that owns the DIR, and the BPO is bpo_enterprise_id. No business identity is accepted in the body.

When signature is omitted the PDF is returned unsigned so the Brand Owner can sign it externally and the BPO can upload it via the Documents API. When signature is present the PDF embeds the supplied image, printed name, and signed-at date.

Returns application/pdf.

POST

dir

{dir_id}

bpo_loa

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.dir.bpoLoa('dir_id', {
  bpo_enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
});

console.log(response.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.dir.bpo_loa(
    dir_id="dir_id",
    bpo_enterprise_id="4a6192a4-573d-446d-b3ce-aff9117272a6",
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Dir.BpoLoa(
		context.TODO(),
		"dir_id",
		telnyx.DirBpoLoaParams{
			BpoEnterpriseID: "4a6192a4-573d-446d-b3ce-aff9117272a6",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.dir.DirBpoLoaParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        DirBpoLoaParams params = DirBpoLoaParams.builder()
            .bpoEnterpriseId("4a6192a4-573d-446d-b3ce-aff9117272a6")
            .build();
        var response = client.dir().bpoLoa("dir_id", params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->dir->bpoLoa(
    'dir_id',
    bpo_enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/dir/{dir_id}/bpo_loa \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bpo_enterprise_id": "4a6192a4-573d-446d-b3ce-aff9117272a6"
}
'

"<string>"

Authorizations

Authorization

string

header

required

Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.

Path Parameters

dir_id

string<uuid>

required

The DIR id.

Body

application/json

bpo_enterprise_id

string<uuid>

required

The approved BPO enterprise the Brand Owner is authorizing. Must be a BPO account on the caller's organization that has already been approved.

Example:

"4a6192a4-573d-446d-b3ce-aff9117272a6"

signature

object

Optional. When provided the rendered PDF embeds the signature image, printed name, and signed-at date. When absent the PDF is returned unsigned so the Brand Owner can sign externally and the BPO can upload it via the Documents API.

Show child attributes

Response

The rendered BPO Authorization LOA PDF.

The response is of type file.

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.dir.bpoLoa('dir_id', {
  bpo_enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
});

console.log(response.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.dir.bpo_loa(
    dir_id="dir_id",
    bpo_enterprise_id="4a6192a4-573d-446d-b3ce-aff9117272a6",
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Dir.BpoLoa(
		context.TODO(),
		"dir_id",
		telnyx.DirBpoLoaParams{
			BpoEnterpriseID: "4a6192a4-573d-446d-b3ce-aff9117272a6",
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.dir.DirBpoLoaParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        DirBpoLoaParams params = DirBpoLoaParams.builder()
            .bpoEnterpriseId("4a6192a4-573d-446d-b3ce-aff9117272a6")
            .build();
        var response = client.dir().bpoLoa("dir_id", params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->dir->bpoLoa(
    'dir_id',
    bpo_enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/dir/{dir_id}/bpo_loa \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bpo_enterprise_id": "4a6192a4-573d-446d-b3ce-aff9117272a6"
}
'

"<string>"

Branded Calling

For AI Agents

Render the BPO Authorization LOA for a DIR

Authorizations

Path Parameters

Body

Response