cid: RumbleUp Account ID

campaignId: Unique identifier for the campaign, mapped directly to tcr_cid in the Action API and used to track related messaging activity.

ok: A boolean indicating the overall status of the campaign. If true, it means everything is in order and ready to sending messages.

status: Indicates the detailed current state of the campaign:

ACTIVE - ready for sending, proxy list contains provisioned numbers

DISABLED - disabled by admin

EXPIRED - expired campaign, no longer can be used

REVIEW FAILED - declined by CNP, requires changes and resubmition to CNP

REVIEW IN PROGRESS - campaign is under review by a CNP

PENDING - proxy provisioning is in progress

usecase: Describes the purpose of the messaging campaign. For instance, “POLITICAL” indicates the campaign is for non-profit political messaging.

brandName: The name of the brand or organization running the campaign, like “TechHelp Services.”

privacyLink: URL to the privacy policy of the brand or campaign.

autoRenewal: A boolean indicating whether the campaign automatically renews. If true, the campaign renews automatically monthly.

helpKeywords: An array of keywords that subscribers can text to receive help, typically including “HELP.”

ageGated: A boolean indicating if the campaign is restricted to subscribers above a certain age. If false, there is no age restriction.

messageFlow: URL to the message flow or opt-in process, which guides subscribers through the steps of subscribing.

messageSentPerDay: Indicates the typical range of messages sent per day, such as “0-1000.”

optinKeywords: An array of keywords that subscribers can text to opt into the campaign, such as JOIN.

optoutKeywords: An array of keywords that subscribers can text to opt out of the campaign, such as STOP or CANCEL.

numberPool: A boolean indicating whether a pool of phone numbers is used for sending messages. If false, a individual numbers are used.

optinMessage: The message sent to subscribers when they opt into receiving messages. This typically includes information on message frequency, potential charges, and instructions for opting out or getting help.

embeddedLink: A boolean indicating whether embedded links are allowed in the messages. If true, they are allowed.

embeddedPhone: A boolean indicating whether embedded phone numbers are allowed in the messages. If true, they are allowed.

directLending: A boolean indicating whether the campaign is related to direct lending services. If false, it is not.

subscriberOptout: A boolean indicating whether the campaign is processing and responding to subscriber opt-out keyword replies. If true, they are processing and responding to opt-out keyword replies.

subscriberOptin: A boolean indicating whether the campaign is collecting and processing required consumer opt-ins. If true, they are collecting required consumer opt in.

sample1: An example message sent to users, often used for review or approval.

sample2: Another example message, typically a variation of the first sample.

createDate: Timestamp indicating when the campaign was created.

billedDate - Campaign recent billed date.

nextRenewalOrExpirationDate - When the campaign would be due for its next renew/bill date.

brandId: A unique identifier for the brand running the campaign.

subscriberHelp: A boolean indicating whether the campaign has implemented message response to subscribers replying with the “HELP” keyword. If true, help message response is implemented.

optoutMessage: The message sent to subscribers when they reply with an opt-out keyword, confirming that they will no longer receive messages.

description: A brief description of the campaign, outlining its purpose and scope.

helpMessage: The message sent to subscribers when they reply with a help keyword, offering assistance or contact information.

sent_time: Timestamp indicating when the last message was sent in the campaign.

brandDailyCap: max number of texts allowed by T-Mobile

proxy: An array containing the proxy number(s) used to send messages.

mnoMetadata - A hash table of MNO properties returned from brand use-case qualification or campaign submission. This structure is exact copy of TCR MNO Metadata

{
  "usecase": "POLITICAL",
  "numberPool": false,
  "optinMessage": "Welcome to TechHelp: Thanks for subscribing to TechHelp alerts. Message frequency varies, standard rates apply. For help, contact support@techhelp.com or text HELP. To opt-out, reply STOP.",
  "status": "ACTIVE",
  "brandName": "TechHelp Services",
  "privacyLink": "https://www.techhelp.com/privacy-policy",
  "autoRenewal": true,
  "helpKeywords": [ "HELP" ],
  "ageGated": false,
  "messageFlow": "https://www.techhelp.com/optin/subscribe",
  "messageSentPerDay": "1000-2000",
  "optinKeywords": [ "SUBSCRIBE" ],
  "optoutKeywords": [ "STOP", "CANCEL" ],
  "cid": "c_xyz123abc456",
  "embeddedLink": true,
  "campaignId": "C12345ABC",
  "embeddedPhone": true,
  "directLending": false,
  "subscriberOptout": true,
  "subscriberOptin": true,
  "sample1": "Hi @name@! Join TechHelp for updates by replying with 'SUBSCRIBE'. Reply STOP to unsubscribe.",
  "sample2": "Hi @name@! Join TechHelp for updates by replying with 'SUBSCRIBE'. Reply STOP to unsubscribe.",
  "createDate": "04/01/2025 12:00 EST",
  "brandId": "B9YXZ123",
  "subscriberHelp": true,
  "optoutMessage": "You have been unsubscribed from TechHelp alerts. No further messages will be sent.",
  "description": "TechHelp support campaign for customer assistance and updates.",
  "helpMessage": "For help with TechHelp services, contact support@techhelp.com or reply HELP. Reply STOP to unsubscribe.",
  "ok": true,
  "brandDailyCap" : 2000,
  "proxy": [ "18005551234" ]
}

Get Proxies: Success Reply Object

{
  "count": 1,
  "data": [
    {
      "campaignId": "X34REA7",
      "cspId": "X5678EWA",
      "status": "ACTIVE",
      "createDate": "01/29/2025 12:52pm EDT",
      "billedDate": "02/27/2025 08:00pm EDT",
      "nextRenewalOrExpirationDate": "04/28/2025 08:00pm EDT",
      "brandId": "X7XRTZWD",
      "brandName": "Acme, Inc",
      "usecase": "POLLING_VOTING",
      "description": "Delivery notifications for medical device equipment.  Lunch and Learns with our phsyician clientele to show them the advanced technology for 2025.",
      "resellerId": "R000000",
      "autoRenewal": true,
      "embeddedLink": true,
      "embeddedPhone": true,
      "numberPool": false,
      "ageGated": false,
      "directLending": false,
      "subscriberOptin": true,
      "subscriberOptout": true,
      "subscriberHelp": true,
      "sample1": "Acme, Inc: Dr. Smith. Your delivery will be delivered today at 2pm EST.  Will this time work for you and staff? If this isn't relevant to you, reply STOP to opt out.",
      "sample2": "Acme, Inc: Dr. Smith are hosting a dinner and learn event on March 15th at The Four Seasons Hotel in NYC.  Would you like to attend?  If this isn't relevant to you, reply STOP to opt out.",
      "messageFlow": "Acme, Inc: Contacts can go to this site to subscribe to receive updates from Acme. Terms & Conditions: <url> Delivery notifications for medical device equipment.  Lunch and Learns with our phsyician clientele to show them the advanced technology for 2025.   Messages & data rates may apply. Message frequency varies. Text HELP or contact 7023534875 for help. Text STOP to stop. Privacy Policy: https://bodybybtl.com/privacy/. Text messaging originator opt-in data and consent will not be shared by us with any third parties.",
      "optinKeywords": [
        "JOIN"
      ],
      "optinMessage": "Acme, Inc: Thank you for subscribing to texts from Acme. Message frequency may vary, Message and data rates may apply. For help, reach out to 7023534875 or text HELP. To opt-out, reply STOP.",
      "helpKeywords": [
        "HELP"
      ],
      "helpMessage": "Acme, Inc: For help, reach out to 9995551212. To opt-out, reply STOP.",
      "optoutKeywords": [
        "CANCEL",
        "STOP",
        "UNSUBSCRIBE"
      ],
      "optoutMessage": "Acme: You are now opted-out and will receive no further messages.",
      "privacyPolicyLink": "https://google.com/privacy/",
      "termsAndConditions": true,
      "termsAndConditionsLink": "https://google.com/terms-of-use/",
      "ok": true,
      "proxy": [
        "12012499000",
        "12012499000",
        "12016198000",
        "12013464000",
        "12013464000",
      ],
      "sent_time": "06/22/2025 03:18pm EDT",
      "brandDailyCap": 200000,
      "mnoMetadata": {
        "10017": {
          "tpmScope": "CAMPAIGN",
          "minMsgSamples": 1,
          "msgClass": "A",
          "reqSubscriberOptout": true,
          "mnoReview": false,
          "mmsTpm": 2400,
          "noEmbeddedPhone": false,
          "mno": "AT&T",
          "tpm": 4500,
          "reqSubscriberHelp": true,
          "reqSubscriberOptin": true,
          "mnoSupport": true,
          "noEmbeddedLink": false,
          "qualify": true
        },
        "10035": {
          "minMsgSamples": 1,
          "reqSubscriberHelp": true,
          "reqSubscriberOptout": false,
          "brandDailyCap": 200000,
          "reqSubscriberOptin": true,
          "mnoReview": false,
          "mnoSupport": true,
          "brandTier": "TOP",
          "noEmbeddedLink": false,
          "noEmbeddedPhone": false,
          "qualify": true,
          "mno": "T-Mobile"
        },
        "10037": {
          "minMsgSamples": 1,
          "reqSubscriberHelp": false,
          "reqSubscriberOptout": false,
          "reqSubscriberOptin": false,
          "mnoReview": false,
          "mnoSupport": true,
          "noEmbeddedLink": false,
          "noEmbeddedPhone": false,
          "qualify": true,
          "mno": "US Cellular"
        },
        "10038": {
          "minMsgSamples": 1,
          "reqSubscriberHelp": false,
          "reqSubscriberOptout": false,
          "reqSubscriberOptin": false,
          "mnoReview": false,
          "mnoSupport": true,
          "noEmbeddedLink": false,
          "noEmbeddedPhone": false,
          "qualify": true,
          "mno": "Verizon Wireless"
        },
        "10631": {
          "minMsgSamples": 1,
          "reqSubscriberHelp": false,
          "reqSubscriberOptout": false,
          "reqSubscriberOptin": false,
          "mnoReview": false,
          "mnoSupport": true,
          "noEmbeddedLink": false,
          "noEmbeddedPhone": false,
          "qualify": true,
          "mno": "ClearSky"
        },
        "10901": {
          "minMsgSamples": 1,
          "reqSubscriberHelp": false,
          "reqSubscriberOptout": false,
          "reqSubscriberOptin": false,
          "mnoReview": false,
          "mnoSupport": true,
          "noEmbeddedLink": false,
          "noEmbeddedPhone": false,
          "qualify": true,
          "mno": "Interop"
        }
      }
    }
  ],
  "total": 1
}