Documentation for version WT amoCRM v.1.2.1

WT Amo CRM library - Documentation
Category: Libraries

Information on working with the library before version 1.3.0.

In version 1.3.0, the library was completely rewritten, but backward compatibility is not broken. Information on working with the v.1.2.1 library is collected here.

System requirements

Joomla 4.2.7+, Joomla 5. PHP 7.4+.

Library version 1.3+ is recommended for working with Joomla 6

Connecting the library to your Joomla extension

use Webtolk\Amocrm\Amocrm;

$amocrm = new Amocrm();
$result_amo_crm = $amocrm->getAccountInfo();

List of library methods

getAccountInfo

The getAccountInfo method of the WT amoCRM library for Joomla returns information about the amoCRM account. In Joomla extensions, it is needed rather to indicate normal communication with amoCRM.

Implemented API method: GET /api/v4/account.

getLeadById

A method for obtaining data of a specific amoCRM lead by its id. The response includes custom lead fields, contacts, companies, piplines id, etc.

Implemented API method: GET /api/v4/leads/{id}.

createLeads

The method allows you to add leads from Joomla to an amoCRM account in batches.

Implemented API method: POST /api/v4/leads.

createLeadsComplex

Complex addition of leads with a contact and a company. The method allows you to add leads with a contact and a company to an account in batches. The added data can be checked in duplicate control.

Implemented API method: POST /api/v4/leads/complex.

getTags

Getting a list of tags for an amoCRM entity.

Implemented API method: GET /api/v4/{entity_type:leads|contacts|companies|customers}/tags.

getLeadsPiplines

A method for getting a list of sales funnels for deals.

Implemented API method: GET /api/v4/leads/pipelines.

getLeadsCustomFields

Method for getting a list of fields for leads in Amo CRM.

Implemented API method: GET /api/v4/leads/custom_fields.

getContactsCustomFields

Method for getting a list of fields for contacts in Amo CRM.

Implemented API method: GET /api/v4/contacts/custom_fields.

getCompaniesCustomFields

Method for getting a list of fields for companies in Amo CRM.

Implemented API method: GET /api/v4/companies/custom_fields.

getCustomersCustomFields

Method for getting a list of fields for customers in Amo CRM.

Implemented API method: GET /api/v4/customers/custom_fields.

getContacts

Method for getting a list of contacts in Amo CRM.

Implemented API method: GET /api/v4/contacts.

getUserById

Get Amo CRM user info by user id.

Implemented API method: GET /api/v4/users/{id}.

getNotes

A list of notes for a specific entity, by entity ID.

Implemented API method: GET /api/v4/{entity_type}/{entity_id}/notes.

addNotes

Adding notes to an entity.

Implemented API method: POST /api/v4/{entity_type}/notes.

Implemented API method: POST /api/v4/{entity_type}/{entity_id}/notes.

Joomla Form Fields collection with data from Amo CRM

The library contains a set of Joomla Form fields with information obtained from Amo CRM.

Accountinfo

Outputs html with data about the Amo CRM account. Example of using Joomla 4 modules and plugins in XML manifests.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="accountinfo" name="accountinfo"/>

Companiestagslist - Companies tags list 

A list of tags for companies in Amo CRM. An example of using Joomla 4 modules and plugins in XML manifests.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="companiestagslist" name="company_tag_id"/>

Contactstagslist - Contacts tags list

A list of tags for contacts in Amo CRM. An example of using Joomla 4 modules and plugins in XML manifests.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="contactstagslist" name="contact_tag_id"/>

Leadcustomfieldslist - Lead custom fields list

A list of custom Amo CRM fields for transactions.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="leadcustomfieldslist" name="lead_custom_field_id"/>

Leadspipelineslist - Leads pipelines list

List of Amo CRM sales funnels.

<field addfieldprefix="Webtolk\Amocrm\Fields" type="leadspipelineslist" name="pipeline_id"/>

Leadstagslist - Leads tags list

List of tags for deals

<field addfieldprefix="Webtolk\Amocrm\Fields" type="leadstagslist" name="lead_tag_id"/>

WebTolk Joomla Extensions

96 Extensions
12 Categories
495 Versions released
567607 Downloads
Cart
Cart is empty