Core Concepts

Account

A customer account on the Call Tools platform.

User

Any user of the system with a valid username or password.

/api/users/

Agent

Any user of the system with the is_agent boolean set to true. Will have a phone, voice mail, etc to utilize the platform as a cell center agent or PBX agent.

/api/users/?is_agent=true

Manager

Any user of the system with the is_manager boolean set to true. Will have administrative access to the account to configure campaigns, edit users, manage contact data, view reports, etc. Can also be a agent.

/api/users/?is_manager=true

Contact

A contact object is the central data management object for the people you are calling or receiving calls from. also known as leads or data. Contacts can be added via API POST individually or in bulk with a CSV import in the web interface.

/api/contacts/

Phone Number

A phone number associated with a contact. A Contact can have multiple phone numbers. A phone number can also exist without a contact association for purposes of routing/blocking a inbound call from a specific number.

/api/phonenumbers/?contact_id=12345

Email Address

A email address associated with a contact. A Contact can have multiple email addresses or none.

/api/emailaddresses/?contact_id=12345

Note

A note object is a text note that an agent has written for a specific contact.

/api/notes/

Call

A Call object is basically just a call log that is written when a call is made or received. Call objects get created after a phone call has hung up usually within 30 seconds.

/api/calls/

Historical Call Disposition

A Historical Call Disposition object is just a log of when an agent saves a call disposition for a contact at the end of a phone call.

/api/historicalcalldisposition/