Class AmoApiClient

Index

Accounts

Calls

addPhoneCall notifyPhoneCall

Companies

getCompanies getCompany getCompanyLinks

Constructors

Contacts

attachChatToContact getContact getContactChats getContactLinks getContactNoteById getContactNotes getContacts getContactsChats getContactsCustomFieldById getContactsCustomFieldGroupById getContactsCustomFieldGroups getContactsCustomFields getContactsNotes getContactsTags updateContact

Events

getEventById getEventTypes getEvents

Leads

getLeadById getLeadLinks getLeads getLeadsWithFilter

Methods

getSalesBots getUrl

Notes

addNote getNoteById getNotesByEntityId getNotesByEntityType

Pipelines

getPipelineById getPipelineStatuses getPipelines

Properties

ShortLinks

getShortLinkForContact

Sources

addSource deleteSourceById getSourceById getSources

Tags

addTag appendTags getTags

Tags for leads

addTagForLeads appendTagsToLead getTagsForLeads

Talks

closeTalkById getTalkById getTalks

Tasks

addTask editTask getTaskById getTasks

Templates

addTemplate deleteTemplateById getTemplateById getTemplates updateTemplateById

Unsorted

getUnsorted getUnsortedByUID

Users

getUserById getUsers

Webhooks

deleteWebhook getWebhooks setWebhook

Widgets

getWidget getWidgets

Accounts

getAccount

getAccount(paramIn?): Promise<any>
Parameters
- Optional paramIn: GetAccountParams
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:91

Calls

addPhoneCall

addPhoneCall(phoneCall): Promise<any>
Parameters
- phoneCall: PhoneCallParams
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:445

notifyPhoneCall

notifyPhoneCall(phoneNumber, userIds?): Promise<any>
Parameters
- phoneNumber: string
- Optional userIds: number[]
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/telephony/call_event
- Defined in AmoApiClient/AmoApiClient.ts:428

Companies

getCompanies

getCompanies(params): Promise<any>
Parameters
- params: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:355

getCompany

getCompany(id, params): Promise<any>
Parameters
- id: number
- params: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:371

getCompanyLinks

getCompanyLinks(companyId): Promise<any>
Parameters
- companyId: number
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#links-list
- Defined in AmoApiClient/AmoApiClient.ts:382

Constructors

constructor

new AmoApiClient(domain, accessToken, options?): AmoApiClient
Parameters
- domain: string
- accessToken: string
- Optional options: AmoApiClientOptions
Returns AmoApiClient
- Defined in AmoApiClient/AmoApiClient.ts:24

Contacts

attachChatToContact

attachChatToContact(chatId, contactId): Promise<any>
Parameters
- chatId: string
- contactId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:345

getContact

getContact(contactId, params): Promise<any>
Parameters
- contactId: number
- params: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:250

getContactChats

getContactChats(contactId): Promise<any>
Parameters
- contactId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:338

getContactLinks

getContactLinks(contactId): Promise<any>
Parameters
- contactId: number
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#links-list
- Defined in AmoApiClient/AmoApiClient.ts:261

getContactNoteById

getContactNoteById(contactId, noteId): Promise<any>
Parameters
- contactId: number
- noteId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:520

getContactNotes

getContactNotes(contactId): Promise<any>
Parameters
- contactId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:513

getContacts

getContacts(params): Promise<any>
Parameters
- params: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:234

getContactsChats

getContactsChats(contactIds): Promise<any>
Parameters
- contactIds: number[]
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:328

getContactsCustomFieldById

getContactsCustomFieldById(customFieldId): Promise<any>
Parameters
- customFieldId: string
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/custom-fields#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BF%D0%BE%D0%BB%D1%8F-%D1%81%D1%83%D1%89%D0%BD%D0%BE%D1%81%D1%82%D0%B8-%D0%BF%D0%BE-%D0%B5%D0%B3%D0%BE-ID
- Defined in AmoApiClient/AmoApiClient.ts:283

getContactsCustomFieldGroupById

getContactsCustomFieldGroupById(groupId): Promise<any>
Parameters
- groupId: string
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/custom-fields#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%8B-%D0%BF%D0%BE%D0%BB%D0%B5%D0%B9-%D1%81%D1%83%D1%89%D0%BD%D0%BE%D1%81%D1%82%D0%B8-%D0%BF%D0%BE-ID-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D1%8B
- Defined in AmoApiClient/AmoApiClient.ts:309

getContactsCustomFieldGroups

getContactsCustomFieldGroups(): Promise<any>
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/custom-fields#%D0%A1%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%B3%D1%80%D1%83%D0%BF%D0%BF-%D0%BF%D0%BE%D0%BB%D0%B5%D0%B9-%D1%81%D1%83%D1%89%D0%BD%D0%BE%D1%81%D1%82%D0%B8
- Defined in AmoApiClient/AmoApiClient.ts:300

getContactsCustomFields

getContactsCustomFields(paramsIn): Promise<any>
Parameters
- paramsIn: any
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/custom-fields#%D0%A1%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%BF%D0%BE%D0%BB%D0%B5%D0%B9-%D1%81%D1%83%D1%89%D0%BD%D0%BE%D1%81%D1%82%D0%B8
- Defined in AmoApiClient/AmoApiClient.ts:271

getContactsNotes

getContactsNotes(params): Promise<any>
Parameters
- params: any
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-list
- Defined in AmoApiClient/AmoApiClient.ts:528

getContactsTags

getContactsTags(paramsIn): Promise<any>
Parameters
- paramsIn: any
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/tags-api#%D0%A1%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D1%82%D0%B5%D0%B3%D0%BE%D0%B2-%D0%B4%D0%BB%D1%8F-%D1%81%D1%83%D1%89%D0%BD%D0%BE%D1%81%D1%82%D0%B8
- Defined in AmoApiClient/AmoApiClient.ts:292

updateContact

updateContact(id, data): Promise<any>
Parameters
- id: number
- data: object
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:317

Events

getEventById

getEventById(eventId, paramWith?): Promise<any>
Parameters
- eventId: number
- Optional paramWith: any
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#events-detail
- Defined in AmoApiClient/AmoApiClient.ts:405

getEventTypes

getEventTypes(): Promise<any>
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#event-types
- Defined in AmoApiClient/AmoApiClient.ts:419

getEvents

getEvents(paramsIn): Promise<any>
Parameters
- paramsIn: any
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#events-list
- Defined in AmoApiClient/AmoApiClient.ts:393

Leads

getLeadById

getLeadById(leadId, params): Promise<any>
Parameters
- leadId: number
- params: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:159

getLeadLinks

getLeadLinks(leadId): Promise<any>
Parameters
- leadId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:169

getLeads

getLeads(params): Promise<any>
Parameters
- params: GetLeadsParams
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:134

getLeadsWithFilter

getLeadsWithFilter(params): Promise<any>
Parameters
- params: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:666

Methods

getSalesBots

getSalesBots(): Promise<any>
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:610

getUrl

getUrl(url, options): Promise<any>
Parameters
- url: string
- options: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:462

Notes

addNote

addNote(entityType, entityId, note): Promise<any>
Parameters
- entityType: string
- entityId: number
- note: Note
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:550

getNoteById

getNoteById(entityType, entityId, noteId): Promise<any>
Parameters
- entityType: string
- entityId: number
- noteId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:543

getNotesByEntityId

getNotesByEntityId(entityType, entityId): Promise<any>
Parameters
- entityType: string
- entityId: number
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-entity-list
- Defined in AmoApiClient/AmoApiClient.ts:536

getNotesByEntityType

getNotesByEntityType(entityType, paramsIn): Promise<any>
Parameters
- entityType: string
- paramsIn: any
Returns Promise<any>
See
https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-list
- Defined in AmoApiClient/AmoApiClient.ts:503

Pipelines

getPipelineById

getPipelineById(pipelineId): Promise<any>
Parameters
- pipelineId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:185

getPipelineStatuses

getPipelineStatuses(pipelineId): Promise<any>
Parameters
- pipelineId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:192

getPipelines

getPipelines(): Promise<any>
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:178

Properties

axios

axios: AxiosInstance

domain

domain: string

ShortLinks

getShortLinkForContact

getShortLinkForContact(url, contactId): Promise<any>
Parameters
- url: string
- contactId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:486

Sources

addSource

addSource(params): Promise<any>
Parameters
- params: SourceParams
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:597

deleteSourceById

deleteSourceById(sourceId): Promise<any>
Parameters
- sourceId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:604

getSourceById

getSourceById(sourceId): Promise<any>
Parameters
- sourceId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:590

getSources

getSources(): Promise<any>
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:583

Tags

`Private` addTag

addTag(entityType, params): Promise<any>
Parameters
- entityType: string
- params: AddTagParams[]
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:710

`Private` appendTags

appendTags(entityType, entityId, tags): Promise<any>
Parameters
- entityType: string
- entityId: number
- tags: Tag[]
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:725

`Private` getTags

getTags(entityType, paramsIn): Promise<any>
Parameters
- entityType: string
- paramsIn: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:692

Tags for leads

addTagForLeads

addTagForLeads(tag): Promise<any>
Parameters
- tag: AddTagParams
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:718

appendTagsToLead

appendTagsToLead(entityId, tags): Promise<any>
Parameters
- entityId: number
- tags: Tag[]
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:737

getTagsForLeads

getTagsForLeads(paramsIn): Promise<any>
Parameters
- paramsIn: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:703

Talks

closeTalkById

closeTalkById(talkId, forceClose?): Promise<any>
Parameters
- talkId: number
- Optional forceClose: boolean
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:477

getTalkById

getTalkById(talkId): Promise<any>
Parameters
- talkId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:469

getTalks

getTalks(paramsIn?): Promise<any>
Parameters
- Optional paramsIn: GetTalkParams
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:454

Tasks

addTask

addTask(task): Promise<any>
Parameters
- task: Task
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:225

editTask

editTask(taskId, data): Promise<any>
Parameters
- taskId: number
- data: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:218

getTaskById

getTaskById(taskId): Promise<any>
Parameters
- taskId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:211

getTasks

getTasks(paramsIn): Promise<any>
Parameters
- paramsIn: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:200

Templates

addTemplate

addTemplate(templates): Promise<any>
Parameters
- templates: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:650

deleteTemplateById

deleteTemplateById(templateId): Promise<any>
Parameters
- templateId: string
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:658

getTemplateById

getTemplateById(templateId): Promise<any>
Parameters
- templateId: string
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:632

getTemplates

getTemplates(paramsIn): Promise<any>
Parameters
- paramsIn: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:621

updateTemplateById

updateTemplateById(templateId, template): Promise<any>
Parameters
- templateId: string
- template: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:641

Unsorted

getUnsorted

getUnsorted(paramsIn): Promise<any>
Parameters
- paramsIn: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:744

getUnsortedByUID

getUnsortedByUID(uid): Promise<any>
Parameters
- uid: string
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:755

Users

getUserById

getUserById(userId): Promise<any>
Parameters
- userId: number
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:122

getUsers

getUsers(): Promise<any>
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:115

Webhooks

deleteWebhook

deleteWebhook(__namedParameters): Promise<any>
Parameters
- __namedParameters: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:79

getWebhooks

getWebhooks(): Promise<any>
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:62

setWebhook

setWebhook(params): Promise<any>
Parameters
- params: WebhookParams
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:69

Widgets

getWidget

getWidget(widgetCode): Promise<any>
Parameters
- widgetCode: string
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:570

getWidgets

getWidgets(params): Promise<any>
Parameters
- params: any
Returns Promise<any>
- Defined in AmoApiClient/AmoApiClient.ts:559

Generated using TypeDoc