Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.partnerCampaigns.listSharedByMe();

console.log(response.page);

{
  "page": 123,
  "records": [
    {
      "brandId": "<string>",
      "campaignId": "<string>",
      "usecase": "<string>",
      "createDate": "<string>",
      "status": "<string>"
    }
  ],
  "totalRecords": 123
}

GET

partnerCampaign

sharedByMe

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.partnerCampaigns.listSharedByMe();

console.log(response.page);

{
  "page": 123,
  "records": [
    {
      "brandId": "<string>",
      "campaignId": "<string>",
      "usecase": "<string>",
      "createDate": "<string>",
      "status": "<string>"
    }
  ],
  "totalRecords": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

default:1

The 1-indexed page number to get. The default value is 1. The 1-indexed page number to get. The default value is 1.

recordsPerPage

integer

default:10

The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10. The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10.

Response

Successful Response

page

integer

records

SharedCampaign · object[]

Show child attributes

records.brandId

string

required

Alphanumeric identifier of the brand associated with this campaign.

records.campaignId

string

required

Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.

records.usecase

string

required

Campaign usecase. Must be of defined valid types. Use /registry/enum/usecase operation to retrieve usecases available for given brand.

records.createDate

string

Unix timestamp when campaign was created.

records.status

string

Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.

totalRecords

integer

Updates an existing outbound voice profile.Get Sharing Status

⌘I

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup