Skip to main content

Get Partner Campaigns Shared By User

GET 
/partnerCampaign/sharedByMe

Get 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.

Responses ​

200: Successful Response

Schema

    page Page (integer)

    records

    object[]

  • Array [

    • brandId Brandid (string)required

    Alphanumeric identifier of the brand associated with this campaign.

    campaignId 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.

    createDate Createdate (string)

    Unix timestamp when campaign was created.

    status Status (string)

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

    usecase Usecase (string)required

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

  • ]

    • 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/partnerCampaign/sharedByMe' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

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