Skip to main content

List Shared Campaigns

GET 
/partner_campaigns

Retrieve all partner campaigns you have shared to Telnyx in a paginated fashion.

This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted. In other words, shared but pending campaigns are currently omitted from the response from this endpoint.

Request ​

Query Parameters

    page Page

    Default value: 1

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

    recordsPerPage Recordsperpage

    Default value: 10

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

    sort Sort

    Possible values: [assignedPhoneNumbersCount, -assignedPhoneNumbersCount, brandDisplayName, -brandDisplayName, tcrBrandId, -tcrBranId, tcrCampaignId, -tcrCampaignId, createdAt, -createdAt, campaignStatus, -campaignStatus]

    Default value: -createdAt

    Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.

    Example: -assignedPhoneNumbersCount

Responses ​

200: Successful Response

Schema

    records

    object[]

  • Array [

    • ageGated AgeGated (boolean)

    Age gated content in campaign.

    assignedPhoneNumbersCount AssignedPhoneNumbersCount (number)

    Number of phone numbers associated with the campaign

    brandDisplayName Branddisplayname

    Display or marketing name of the brand.

    campaignStatus campaignStatus

    Possible values: [TCR_PENDING, TCR_SUSPENDED, TCR_EXPIRED, TCR_ACCEPTED, TCR_FAILED, TELNYX_ACCEPTED, TELNYX_FAILED, MNO_PENDING, MNO_ACCEPTED, MNO_REJECTED, MNO_PROVISIONED, MNO_PROVISIONING_FAILED]

    Campaign status

    description Description (string)

    Summary description of this campaign.

    directLending Directlending (boolean)

    Direct lending or loan arrangement.

    embeddedLink Embeddedlink (boolean)

    Does message generated by the campaign include URL link in SMS?

    embeddedLinkSample EmbeddedLinkSample (string)

    Sample of an embedded link that will be sent to subscribers.

    embeddedPhone Embeddedphone (boolean)

    Does message generated by the campaign include phone number in SMS?

    failureReasons failureReasons

    Failure reasons if campaign submission failed

    helpKeywords Helpkeywords (string)

    Subscriber help keywords. Multiple keywords are comma separated without space.

    helpMessage Helpmessage (string)

    Help message of the campaign.

    isNumberPoolingEnabled isNumberPoolingEnabled (boolean)

    Indicates whether the campaign has a T-Mobile number pool ID associated with it.

    messageFlow Messageflow (string)

    Message flow description.

    numberPool Numberpool (boolean)

    Does campaign utilize pool of phone numbers?

    optinKeywords Optinkeywords (string)

    Subscriber opt-in keywords. Multiple keywords are comma separated without space.

    optinMessage Optinmessage (string)

    Subscriber opt-in message.

    optoutKeywords Optoutkeywords (string)

    Subscriber opt-out keywords. Multiple keywords are comma separated without space.

    optoutMessage Optoutmessage (string)

    Subscriber opt-out message.

    privacyPolicyLink PrivacyPolicyLink (string)

    Link to the campaign's privacy policy.

    usecase Usecase (string)

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

    sample1 Sample1 (string)

    Message sample. Some campaign tiers require 1 or more message samples.

    sample2 Sample2 (string)

    Message sample. Some campaign tiers require 2 or more message samples.

    sample3 Sample3 (string)

    Message sample. Some campaign tiers require 3 or more message samples.

    sample4 Sample4 (string)

    Message sample. Some campaign tiers require 4 or more message samples.

    sample5 Sample5 (string)

    Message sample. Some campaign tiers require 5 or more message samples.

    subUsecases string[]

    Campaign sub-usecases. Must be of defined valid sub-usecase types. Use /registry/enum/usecase operation to retrieve list of valid sub-usecases

    subscriberOptin Subscriberoptin (boolean)

    Does campaign require subscriber to opt-in before SMS is sent to subscriber?

    subscriberOptout Subscriberoptout (boolean)

    Does campaign support subscriber opt-out keyword(s)?

    tcrBrandId TcrBrandid (string)required

    Unique identifier assigned to the brand by the registry.

    tcrCampaignId TcrCampaignid (string)required

    Unique identifier assigned to the campaign by the registry.

    termsAndConditions Termsandconditions (boolean)

    Is terms & conditions accepted?

    termsAndConditionsLink TermsAndConditionsLink (string)

    Link to the campaign's terms and conditions.

    webhookURL WebhookURL (string)

    Webhook to which campaign status updates are sent.

    webhookFailoverURL WebhookFailoverURL (string)

    Failover webhook to which campaign status updates are sent.

    createdAt string

    Date and time that the brand was created at.

    updatedAt string

    Date and time that the brand was last updated at.

  • ]

    • page Page (integer)
    totalRecords Totalrecords (integer)

422: Validation Error

Schema

    detail

    object[]

  • Array [

    • loc

    object[]

    required

  • Array [

    • anyOf

    string

  • ]

    • msg Message (string)required
    type Error Type (string)required

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/10dlc/partner_campaigns' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "records": [
    {
      "ageGated": true,
      "assignedPhoneNumbersCount": 3,
      "brandDisplayName": "ABC Mobile",
      "campaignStatus": "TCR_ACCEPTED",
      "description": "string",
      "directLending": true,
      "embeddedLink": true,
      "embeddedLinkSample": "string",
      "embeddedPhone": true,
      "helpKeywords": "string",
      "helpMessage": "string",
      "isNumberPoolingEnabled": true,
      "messageFlow": "string",
      "numberPool": true,
      "optinKeywords": "string",
      "optinMessage": "string",
      "optoutKeywords": "string",
      "optoutMessage": "string",
      "privacyPolicyLink": "string",
      "usecase": "string",
      "sample1": "string",
      "sample2": "string",
      "sample3": "string",
      "sample4": "string",
      "sample5": "string",
      "subUsecases": [
        "string"
      ],
      "subscriberOptin": true,
      "subscriberOptout": true,
      "tcrBrandId": "BBRAND1",
      "tcrCampaignId": "CCAMP1",
      "termsAndConditions": true,
      "termsAndConditionsLink": "string",
      "webhookURL": "https://example.com/webhook",
      "webhookFailoverURL": "https://example.com/failover-webhook",
      "createdAt": "2021-03-08T17:57:48.801186",
      "updatedAt": "2021-03-08T17:57:48.801186"
    }
  ],
  "page": 0,
  "totalRecords": 0
}