Overview

The TCR (The Campaign Registry) API provides endpoints for managing and retrieving information about your campaigns.

This includes listing campaigns and the associated phone numbers that can send messages on behalf of each campaign. This is particularly useful when integrating with the action API, where you might need to reference tcr_cid (campaign ID) and tcr_phone (phone number) fields.

A TCR campaign requires several step before it can be used, for simplicity each campaign object contains a boolean field ok, true means all is done and it is ready to be used.

Once a campaign is ready the proxy field will contains a list of number to be used for sending, any number from this list or all can be used in the Action API, passed as tcr_phone, see Action API docs for more details.