Your Resources
Before you continue charging ahead and start implementing parts of the API in your own applications, it's best to understand what each resource is and their purpose in the overall system.
Account
At the top of the resources is the Account.
The account contains all the information about your company, business or entity, as well as your billing information.
The Account will then parent all other resources.
DID
The DID is a phone number or sender ID provisioned in the system for various telecom services.
A DID may be simply referred to as a 'Number'.
Switch
The Switch is a routing record used by the system to determine where:
- Incoming SMS Messages should be delivered, format, and any additional authorization
- Incoming MMS Messages should be delivered, format, and any additional authorization
- Fallback destination for incoming Voice calls
As one may notice, the switch handles inbound, or incoming actions only.
Outbound routing is handled by various internal systems and is beyond the scope of this document.
Messaging Auto Responses
Messaging Auto Responses, sometimes just referred to as Auto Responses, or Auto Responders are user defined keyword plans.
You, the user can create an auto resposne with one or more keywords, when an inbound message is received, it will be checked against the auto response to determine if a reply can or should be generated.
Note. If your account was assigned a keyword plan, an auto response can be used to customize the network-level responses generated (while keeping the same functionality).
If the keyword plan contains a STOP keyword, and the auto response contains a STOP keyword, the latter's messages will be used.
Role
A role is a collection of permissions that a user may have.
User
A user or agent is an entity that has a Role which affects their permission to access some resources.
Note that some APIs do not require a user and its permissions will be affected by the account's settings instead.
API Key
An API Key is the token and or auth required to access any of Tychron's APIs, there are two types of API Keys:
- Standard API Keys
- Impersonated API Keys
Standard API Keys
Standard API Keys are those that can be used for SMS, MMS, LRN and CNAM services, as these services do not require additional permissions outside of those set on the account.
Impersonated API Keys
Impersonated API Keys are those that perform actions on behalf of a user, such as requesting messaging for a set of numbers, or disconnecting a number from service.
Impersonated keys are required to access most /api/v1 routes outside of LRN and CNAM and some select routes.
Bulk Dip Tasks
Note Experimental
A new feature, the bulk dip tasks allows you to request a specific dipping action for up to 20000 numbers at a time, you can create as many tasks as you wish.
Please note, standard dipping rates apply, going over your account's balance will return errors for all subsequent rows in the task.
CSP
CSP Resources are records from the TCR.
If you have any questions about TCR related issues or services, please contact support.
CSP Brands
A brand describes business entity that will be running messaging campaigns.
The brand by itself does nothing, you must create campaigns in order to make use of it.
There can be multiple brands bound to the account.
CSP Campaigns
A campaign describes a specific messaging case, such as sending notices or notifications to a client when something happens.
There can be multiple campaigns under the same brand, normally for different use cases.
Shared Resource Groups
Shared Resource Groups allow donating resources (currently only CSP Campaigns) to other accounts for usage as if it were their own.
This is used to allow another account to utilize a resource that is owned by the account without requiring the donee (i.e. the account that is being donated to) to manage that resource.
Contact support for more information if you require shared resources.