Class AmoApiClient

getAccount

• getAccount(paramIn?: GetAccountParams): Promise<any>

  Parameters

  • OptionalparamIn: GetAccountParams

  Returns Promise<any>

addPhoneCall

• addPhoneCall(phoneCall: PhoneCallParams): Promise<any>

  Parameters

  • phoneCall: PhoneCallParams

  Returns Promise<any>

notifyPhoneCall

• notifyPhoneCall(phoneNumber: string, userIds?: number[]): Promise<any>

  Parameters

  • phoneNumber: string
  • OptionaluserIds: number[]

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/telephony/call_event

addCompany

• addCompany(company: Company): Promise<any>

  Parameters

  • company: Company

  Returns Promise<any>

getCompanies

• getCompanies(params: PageParams & QueryParams): Promise<any>

  Parameters

  • params: PageParams & QueryParams

  Returns Promise<any>

getCompaniesCustomFieldById

• getCompaniesCustomFieldById(customFieldId: string): Promise<any>

  syntax sugar getCustomFieldById

  Parameters

  • customFieldId: string

  Returns Promise<any>

getCompaniesCustomFieldGroupById

• getCompaniesCustomFieldGroupById(groupId: string): Promise<any>

  Parameters

  • groupId: string

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/custom-fields#Получение-группы-полей-сущности-по-ID-группы

getCompaniesCustomFieldGroups

• getCompaniesCustomFieldGroups(): Promise<any>

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/custom-fields#Список-групп-полей-сущности

getCompaniesCustomFields

• getCompaniesCustomFields(paramsIn: PageParams): Promise<any>

  syntax sugar getCustomFieldsByEntityType

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

getCompaniesNotes

• getCompaniesNotes(params: PageParams): Promise<any>

  syntax sugar getNotesByEntityType

  Parameters

  • params: PageParams

  Returns Promise<any>

getCompaniesTags

• getCompaniesTags(paramsIn: PageParams): Promise<any>

  syntax sugar getTags

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

getCompany

• getCompany(companyId: number, params: { leads?: boolean }): Promise<any>

  Parameters

  • companyId: number
  • params: { leads?: boolean }

  Returns Promise<any>

getCompanyFiles

• getCompanyFiles(companyId: number): Promise<any>

  syntax sugar getEntityFiles

  Parameters

  • companyId: number

  Returns Promise<any>

getCompanyLinks

• getCompanyLinks(companyId: number): Promise<any>

  syntax sugar getLinksByEntityType

  Parameters

  • companyId: number

  Returns Promise<any>

getCompanyNoteById

• getCompanyNoteById(companyId: number, noteId: number): Promise<any>

  syntax sugar getNoteById

  Parameters

  • companyId: number
  • noteId: number

  Returns Promise<any>

getCompanyNotes

• getCompanyNotes(companyId: number): Promise<any>

  syntax sugar getNotesByEntityId

  Parameters

  • companyId: number

  Returns Promise<any>

constructor

• new AmoApiClient(
      domain: string,
      accessToken: string,
      options?: AmoApiClientOptions,
  ): AmoApiClient

  Parameters

  • domain: string
  • accessToken: string
  • Optionaloptions: AmoApiClientOptions

  Returns AmoApiClient

addContact

• addContact(contact: Contact): Promise<any>

  Parameters

  • contact: Contact

  Returns Promise<any>

addContactsCustomFields

• addContactsCustomFields(fields: CustomFieldData[]): Promise<any>

  syntax sugar addCustomFields

  Parameters

  • fields: CustomFieldData[]

  Returns Promise<any>

addNoteToContact

• addNoteToContact(contactId: number, note: Note): Promise<any>

  syntax sugar addNote

  Parameters

  • contactId: number
  • note: Note

  Returns Promise<any>

attachChatToContact

• attachChatToContact(chatId: string, contactId: number): Promise<any>

  Parameters

  • chatId: string
  • contactId: number

  Returns Promise<any>

getContact

• getContact(contactId: number, params: { leads?: boolean }): Promise<any>

  Parameters

  • contactId: number
  • params: { leads?: boolean }

  Returns Promise<any>

getContactChats

• getContactChats(contactId: number): Promise<any>

  Parameters

  • contactId: number

  Returns Promise<any>

getContactFiles

• getContactFiles(contactId: number): Promise<any>

  syntax sugar getEntityFiles

  Parameters

  • contactId: number

  Returns Promise<any>

getContactLinks

• getContactLinks(contactId: number): Promise<any>

  Parameters

  • contactId: number

  Returns Promise<any>

getContactNoteById

• getContactNoteById(contactId: number, noteId: number): Promise<any>

  Parameters

  • contactId: number
  • noteId: number

  Returns Promise<any>

getContactNotes

• getContactNotes(contactId: number): Promise<any>

  Parameters

  • contactId: number

  Returns Promise<any>

getContacts

• getContacts(params: PageParams & QueryParams): Promise<any>

  Parameters

  • params: PageParams & QueryParams

  Returns Promise<any>

getContactsChats

• getContactsChats(contactIds: number[]): Promise<any>

  Parameters

  • contactIds: number[]

  Returns Promise<any>

getContactsCustomFieldById

• getContactsCustomFieldById(customFieldId: string): Promise<any>

  syntax sugar getCustomFieldById

  Parameters

  • customFieldId: string

  Returns Promise<any>

getContactsCustomFieldGroupById

• getContactsCustomFieldGroupById(groupId: string): Promise<any>

  Parameters

  • groupId: string

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/custom-fields#Получение-группы-полей-сущности-по-ID-группы

getContactsCustomFieldGroups

• getContactsCustomFieldGroups(): Promise<any>

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/custom-fields#Список-групп-полей-сущности

getContactsCustomFields

• getContactsCustomFields(paramsIn: PageParams): Promise<any>

  syntax sugar getCustomFieldsByEntityType

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

getContactsNotes

• getContactsNotes(params: PageParams): Promise<any>

  syntax sugar getNotesByEntityType

  Parameters

  • params: PageParams

  Returns Promise<any>

getContactsTags

• getContactsTags(paramsIn: PageParams): Promise<any>

  syntax sugar getTags

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

linkFileToContact

• linkFileToContact(fileUUID: string, contactId: number): Promise<any>

  Parameters

  • fileUUID: string
  • contactId: number

  Returns Promise<any>

updateContact

• updateContact(id: number, data: object): Promise<any>

  Parameters

  • id: number
  • data: object

  Returns Promise<any>

getEntityFiles

• getEntityFiles(entityType: string, contactId: number): Promise<any>

  Parameters

  • entityType: string
  • contactId: number

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/files/files-api#Получение-файлов-связанных-с-сущностью

getCustomFieldById

• getCustomFieldById(entityType: string, customFieldId: string): Promise<any>

  Parameters

  • entityType: string
  • customFieldId: string

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/custom-fields#Получение-поля-сущности-по-его-ID

getCustomFieldsByEntityType

• getCustomFieldsByEntityType(
      entityType: string,
      params: PageParams,
  ): Promise<any>

  Parameters

  • entityType: string
  • params: PageParams

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/custom-fields#Список-полей-сущности

getLinksByEntityType

• getLinksByEntityType(entityType: string, entityId: number): Promise<any>

  Parameters

  • entityType: string
  • entityId: number

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/entity-links-api#links-list

getEventById

• getEventById(
      eventId: number,
      paramWith?: {
          catalogElements?: boolean;
          contacts?: boolean;
          lossReason?: boolean;
      },
  ): Promise<any>

  Parameters

  • eventId: number
  • OptionalparamWith: { catalogElements?: boolean; contacts?: boolean; lossReason?: boolean }

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#events-detail

getEvents

• getEvents(paramsIn: PageParams): Promise<any>

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#events-list

getEventTypes

• getEventTypes(): Promise<any>

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#event-types

addLead

• addLead(leadData: EntityData): Promise<any>

  Parameters

  • leadData: EntityData

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/leads-api#leads-add

addLeadsCustomFields

• addLeadsCustomFields(fields: CustomFieldData[]): Promise<any>

  syntax sugar addCustomFields

  Parameters

  • fields: CustomFieldData[]

  Returns Promise<any>

addNoteToLead

• addNoteToLead(leadId: number, note: Note): Promise<any>

  syntax sugar addNote

  Parameters

  • leadId: number
  • note: Note

  Returns Promise<any>

addTagForLeads

• addTagForLeads(tag: AddTagParams): Promise<any>

  Parameters

  • tag: AddTagParams

  Returns Promise<any>

appendTagsToLead

• appendTagsToLead(entityId: number, tags: Tag[]): Promise<any>

  syntax sugar appendTags

  Parameters

  • entityId: number
  • tags: Tag[]

  Returns Promise<any>

getBaseLeadPayload

• getBaseLeadPayload(
      name: string,
      price: number,
      createdBy?: number,
  ): { created_by: number; name: string; price: number }

  Parameters

  • name: string
  • price: number
  • OptionalcreatedBy: number

  Returns { created_by: number; name: string; price: number }

getLeadById

• getLeadById(leadId: number, params: { contacts?: boolean }): Promise<any>

  Parameters

  • leadId: number
  • params: { contacts?: boolean }

  Returns Promise<any>

getLeadFiles

• getLeadFiles(leadId: number): Promise<any>

  Parameters

  • leadId: number

  Returns Promise<any>

getLeadLinks

• getLeadLinks(leadId: number): Promise<any>

  syntax sugar getLinksByEntityType

  Parameters

  • leadId: number

  Returns Promise<any>

getLeadNoteById

• getLeadNoteById(leadId: number, noteId: number): Promise<any>

  syntax sugar getNotesByEntityType

  Parameters

  • leadId: number
  • noteId: number

  Returns Promise<any>

getLeads

• getLeads(params: GetLeadsParams): Promise<any>

  Parameters

  • params: GetLeadsParams

  Returns Promise<any>

getLeadsCustomFieldById

• getLeadsCustomFieldById(customFieldId: string): Promise<any>

  syntax sugar getCustomFieldById

  Parameters

  • customFieldId: string

  Returns Promise<any>

getLeadsCustomFieldGroupById

• getLeadsCustomFieldGroupById(groupId: string): Promise<any>

  Parameters

  • groupId: string

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/custom-fields#Получение-группы-полей-сущности-по-ID-группы

getLeadsCustomFieldGroups

• getLeadsCustomFieldGroups(): Promise<any>

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/custom-fields#Список-групп-полей-сущности

getLeadsCustomFields

• getLeadsCustomFields(paramsIn: PageParams): Promise<any>

  syntax sugar getCustomFieldsByEntityType

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

getLeadsNotes

• getLeadsNotes(params: PageParams): Promise<any>

  syntax sugar getNotesByEntityType

  Parameters

  • params: PageParams

  Returns Promise<any>

getLeadsTags

• getLeadsTags(paramsIn: PageParams): Promise<any>

  syntax sugar getTags

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

getLeadsWithFilter

• getLeadsWithFilter(
      params: PageParams & QueryParams & { filter?: FilterParams },
  ): Promise<any>

  Parameters

  • params: PageParams & QueryParams & { filter?: FilterParams }

  Returns Promise<any>

getLossReasons

• getLossReasons(): Promise<any>

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/leads-api#leads-edit

getPipelineLeadPayload

• getPipelineLeadPayload(
      pipelineId: number,
      statusId?: number,
  ): { pipeline_id: number; status_id: number }

  Parameters

  • pipelineId: number
  • OptionalstatusId: number

  Returns { pipeline_id: number; status_id: number }

getTagsForLeads

• getTagsForLeads(paramsIn: PageParams): Promise<any>

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

linkFileToLead

• linkFileToLead(fileUUID: string, leadId: number): Promise<any>

  Parameters

  • fileUUID: string
  • leadId: number

  Returns Promise<any>

updateLead

• updateLead(data: EntityData): Promise<any>

  Parameters

  • data: EntityData

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/leads-api#leads-edit

getContactPayload

• getContactPayload(name: string, phone: string): Contact

  Parameters

  • name: string
  • phone: string

  Returns Contact

getSalesBots

• getSalesBots(): Promise<any>

  Returns Promise<any>

getUrl

• getUrl(url: string, options: Record<string, unknown>): Promise<any>

  Parameters

  • url: string
  • options: Record<string, unknown>

  Returns Promise<any>

addNote

• addNote(entityType: string, entityId: number, note: Note): Promise<any>

  Parameters

  • entityType: string
  • entityId: number
  • note: Note

  Returns Promise<any>

getNoteById

• getNoteById(entityType: string, entityId: number, noteId: number): Promise<any>

  Parameters

  • entityType: string
  • entityId: number
  • noteId: number

  Returns Promise<any>

getNotesByEntityId

• getNotesByEntityId(entityType: string, entityId: number): 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

getNotesByEntityType

• getNotesByEntityType(entityType: string, paramsIn: PageParams): Promise<any>

  Parameters

  • entityType: string
  • paramsIn: PageParams

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/events-and-notes#notes-list

getPipelineById

• getPipelineById(pipelineId: number): Promise<any>

  Parameters

  • pipelineId: number

  Returns Promise<any>

getPipelines

• getPipelines(): Promise<any>

  Returns Promise<any>

getPipelineStatuses

• getPipelineStatuses(pipelineId: number): Promise<any>

  Parameters

  • pipelineId: number

  Returns Promise<any>

axios

domain

getShortLinkForContact

• getShortLinkForContact(url: string, contactId: number): Promise<any>

  Parameters

  • url: string
  • contactId: number

  Returns Promise<any>

addSource

• addSource(params: SourceParams): Promise<any>

  Parameters

  • params: SourceParams

  Returns Promise<any>

deleteSourceById

• deleteSourceById(sourceId: number): Promise<any>

  Parameters

  • sourceId: number

  Returns Promise<any>

getSourceById

• getSourceById(sourceId: number): Promise<any>

  Parameters

  • sourceId: number

  Returns Promise<any>

getSources

• getSources(): Promise<any>

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/sources-api

closeTalkById

• closeTalkById(talkId: number, forceClose?: boolean): Promise<any>

  Parameters

  • talkId: number
  • OptionalforceClose: boolean

  Returns Promise<any>

getTalkById

• getTalkById(talkId: number): Promise<any>

  Parameters

  • talkId: number

  Returns Promise<any>

getTalks

• getTalks(paramsIn?: GetTalkParams): Promise<any>

  Parameters

  • OptionalparamsIn: GetTalkParams

  Returns Promise<any>

addTask

• addTask(task: Task): Promise<any>

  Parameters

  • task: Task

  Returns Promise<any>

editTask

• editTask(taskId: number, data: EntityData): Promise<any>

  Parameters

  • taskId: number
  • data: EntityData

  Returns Promise<any>

getTaskById

• getTaskById(taskId: number): Promise<any>

  Parameters

  • taskId: number

  Returns Promise<any>

getTasks

• getTasks(paramsIn: PageParams): Promise<any>

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

addTemplate

• addTemplate(templates: TemplateData): Promise<any>

  Parameters

  • templates: TemplateData

  Returns Promise<any>

deleteTemplateById

• deleteTemplateById(templateId: string): Promise<any>

  Parameters

  • templateId: string

  Returns Promise<any>

getTemplateById

• getTemplateById(templateId: string): Promise<any>

  Parameters

  • templateId: string

  Returns Promise<any>

getTemplates

• getTemplates(paramsIn: PageParams): Promise<any>

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

updateTemplateById

• updateTemplateById(templateId: string, template: TemplateData): Promise<any>

  Parameters

  • templateId: string
  • template: TemplateData

  Returns Promise<any>

acceptUnsorted

• acceptUnsorted(uid: string, userId: number, statusId: number): Promise<any>

  Parameters

  • uid: string
  • userId: number
  • statusId: number

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-add-form

addUnsortedForms

• addUnsortedForms(data: UnsortedData): Promise<any>

  Parameters

  • data: UnsortedData

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-add-form

addUnsortedSip

• addUnsortedSip(data: UnsortedData): Promise<any>

  Parameters

  • data: UnsortedData

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-add-sip

declineUnsorted

• declineUnsorted(uid: string, userId?: number): Promise<any>

  Parameters

  • uid: string
  • OptionaluserId: number

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-decline

getUnsorted

• getUnsorted(paramsIn: PageParams): Promise<any>

  Parameters

  • paramsIn: PageParams

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-list

getUnsortedByUID

• getUnsortedByUID(uid: string): Promise<any>

  Parameters

  • uid: string

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-detail

getUnsortedSummary

• getUnsortedSummary(): Promise<any>

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-summary

linkUnsorted

• linkUnsorted(uid: string, data: UnsortedData): Promise<any>

  Parameters

  • uid: string
  • data: UnsortedData

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/unsorted-api#unsorted-link

getUserById

• getUserById(userId: number): Promise<any>

  Parameters

  • userId: number

  Returns Promise<any>

getUsers

• getUsers(): Promise<any>

  Returns Promise<any>

  See

  https://www.amocrm.ru/developers/content/crm_platform/users-api#users-list

deleteWebhook

• deleteWebhook(__namedParameters: { destination: string }): Promise<any>

  Parameters

  • __namedParameters: { destination: string }

  Returns Promise<any>

getWebhookEvents

• getWebhookEvents(): string[]

  список возможных событий зафиксирован в коде (необходимо эпизодически сверяться с документацией на актуальность)

  Returns string[]

  See

  https://www.amocrm.ru/developers/content/crm_platform/webhooks-api#webhooks-available-actions

getWebhooks

• getWebhooks(): Promise<any>

  Returns Promise<any>

setWebhook

• setWebhook(params: WebhookParams): Promise<any>

  Parameters

  • params: WebhookParams

  Returns Promise<any>

getWidget

• getWidget(widgetCode: string): Promise<any>

  Parameters

  • widgetCode: string

  Returns Promise<any>

getWidgets

• getWidgets(params: PageParams): Promise<any>

  Parameters

  • params: PageParams

  Returns Promise<any>