A Proxy object contains information about a phone number that can be used to send messages via the API. Each proxy includes identifying details such as the number, associated account, and status. This object is returned by the Proxy API and can be referenced when sending messages programmatically.

Example Object

{
  "cid": "c_abc123",
  "proxy": "19995551234",
  "create_time": "2026-03-31 14:00:00 GMT-0600",
  "update_time": "2026-03-31 14:05:00 GMT-0600",
  "referenceId": "r_789xyz",
  "campaignId": "C123XYZ",
  "campaignName": "Spring Promo Campaign",
  "brandId": "B456ABC",
  "brandName": "Example Brand",
  "status": "ok"
}

Attributes

cid - Account ID the proxy belongs to

proxy - 10-digit phone number or 4-6-digit short code number

create_time - Date when this proxy was allocated

update_time - Date when this proxy was updated

referenceId - An unique ID given during proxy order for tracking purposes

campaignId - TCR campaign this number paired with

campaignName - TCR campaign name

brandId - TCR brand

brandName - TCR brand name

status - Status of the proxy, indicates readiness for sending. Allowed values include:

ok - The proxy is ready for sending

done - The proxy is no longer available

pending - The proxy is being provisioned still

error - The proxy is in error state

failed - Provisioning failed, in most cases this is TCR paring or TF verification issue