Class AmoApiClient

getAccount

• getAccount(paramIn?): Promise<any>

• Parameters

  • Optional paramIn: GetAccountParams

  Returns Promise<any>

addPhoneCall

• addPhoneCall(phoneCall): Promise<any>

• Parameters

  • phoneCall: PhoneCallParams

  Returns Promise<any>

notifyPhoneCall

• notifyPhoneCall(phoneNumber, userIds?): Promise<any>

• Parameters

  • phoneNumber: string

  • Optional userIds: number[]

  Returns Promise<any>

getCompanies

• getCompanies(params): Promise<any>

• Parameters

  • params: any

  Returns Promise<any>

getCompany

• getCompany(id, params): Promise<any>

• Parameters

  • id: number

  • params: any

  Returns Promise<any>

mergeCompanies

• mergeCompanies(data): Promise<any>

• Parameters

  • data: MergeCompaniesParams

  Returns Promise<any>

  Deprecated

  deprecated method

constructor

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

• Parameters

  • domain: string

  • accessToken: string

  • Optional options: AmoApiClientOptions

  Returns AmoApiClient

attachChatToContact

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

• Parameters

  • chatId: string

  • contactId: number

  Returns Promise<any>

getContact

• getContact(contactId, params): Promise<any>

• Parameters

  • contactId: number

  • params: any

  Returns Promise<any>

getContactChats

• getContactChats(contactId): Promise<any>

• Parameters

  • contactId: number

  Returns Promise<any>

getContacts

• getContacts(params): Promise<any>

• Parameters

  • params: any

  Returns Promise<any>

getContactsChats

• getContactsChats(contactIds): Promise<any>

• Parameters

  • contactIds: number[]

  Returns Promise<any>

mergeContacts

• mergeContacts(data): Promise<any>

• Parameters

  • data: MergeContactsParams

  Returns Promise<any>

  Deprecated

  deprecated method

updateContact

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

• Parameters

  • id: number

  • data: object

  Returns Promise<any>

getEventById

• getEventById(eventId, paramWith?): Promise<any>

• Parameters

  • eventId: number

  • Optional paramWith: any

  Returns Promise<any>

getEvents

• getEvents(params): Promise<any>

• Parameters

  • params: any

  Returns Promise<any>

getLeadById

• getLeadById(leadId, params): Promise<any>

• Parameters

  • leadId: number

  • params: any

  Returns Promise<any>

getLeadLinks

• getLeadLinks(leadId): Promise<any>

• Parameters

  • leadId: number

  Returns Promise<any>

getLeads

• getLeads(params): Promise<any>

• Parameters

  • params: GetLeadsParams

  Returns Promise<any>

getLeadsWithFilter

• getLeadsWithFilter(params): Promise<any>

• Parameters

  • params: any

  Returns Promise<any>

getSalesBots

• getSalesBots(): Promise<any>

• Returns Promise<any>

addNote

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

• Parameters

  • entityType: string

  • entityId: number

  • note: Note

  Returns Promise<any>

getNoteById

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

• Parameters

  • entityType: string

  • entityId: number

  • noteId: number

  Returns Promise<any>

getNotesByEntityId

• getNotesByEntityId(entityType, entityId): Promise<any>

• Parameters

  • entityType: string

  • entityId: number

  Returns Promise<any>

getNotesByEntityType

• getNotesByEntityType(entityType): Promise<any>

• Parameters

  • entityType: string

  Returns Promise<any>

getPipelineById

• getPipelineById(pipelineId): Promise<any>

• Parameters

  • pipelineId: number

  Returns Promise<any>

getPipelineStatuses

• getPipelineStatuses(pipelineId): Promise<any>

• Parameters

  • pipelineId: number

  Returns Promise<any>

getPipelines

• getPipelines(): Promise<any>

• Returns Promise<any>

axios

domain

getShortLinkForContact

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

• Parameters

  • url: string

  • contactId: number

  Returns Promise<any>

addSource

• addSource(params): Promise<any>

• Parameters

  • params: SourceParams

  Returns Promise<any>

deleteSourceById

• deleteSourceById(sourceId): Promise<any>

• Parameters

  • sourceId: number

  Returns Promise<any>

getSourceById

• getSourceById(sourceId): Promise<any>

• Parameters

  • sourceId: number

  Returns Promise<any>

getSources

• getSources(): Promise<any>

• Returns Promise<any>

addTagForLeads

• addTagForLeads(tag): Promise<any>

• Parameters

  • tag: AddTagParams

  Returns Promise<any>

appendTagsToLead

• appendTagsToLead(entityId, tags): Promise<any>

• Parameters

  • entityId: number

  • tags: Tag[]

  Returns Promise<any>

getTagsForLeads

• getTagsForLeads(paramsIn): Promise<any>

• Parameters

  • paramsIn: any

  Returns Promise<any>

closeTalkById

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

• Parameters

  • talkId: number

  • Optional forceClose: boolean

  Returns Promise<any>

getTalkById

• getTalkById(talkId): Promise<any>

• Parameters

  • talkId: number

  Returns Promise<any>

getTalks

• getTalks(paramsIn?): Promise<any>

• Parameters

  • Optional paramsIn: GetTalkParams

  Returns Promise<any>

addTask

• addTask(task): Promise<any>

• Parameters

  • task: Task

  Returns Promise<any>

deleteTask

• deleteTask(taskId, leadId): Promise<any>

• Parameters

  • taskId: number

  • leadId: number

  Returns Promise<any>

  Deprecated

  deprecated method

editTask

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

• Parameters

  • taskId: number

  • data: any

  Returns Promise<any>

getAdditionalTaskTypes

• getAdditionalTaskTypes(): Promise<any>

• Returns Promise<any>

  Deprecated

  deprecated method

getTaskById

• getTaskById(taskId): Promise<any>

• Parameters

  • taskId: number

  Returns Promise<any>

getTasks

• getTasks(paramsIn): Promise<any>

• Parameters

  • paramsIn: any

  Returns Promise<any>

addTemplate

• addTemplate(templates): Promise<any>

• Parameters

  • templates: any

  Returns Promise<any>

deleteTemplateById

• deleteTemplateById(templateId): Promise<any>

• Parameters

  • templateId: string

  Returns Promise<any>

getTemplateById

• getTemplateById(templateId): Promise<any>

• Parameters

  • templateId: string

  Returns Promise<any>

getTemplates

• getTemplates(paramsIn): Promise<any>

• Parameters

  • paramsIn: any

  Returns Promise<any>

updateTemplateById

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

• Parameters

  • templateId: string

  • template: any

  Returns Promise<any>

getUnsorted

• getUnsorted(paramsIn): Promise<any>

• Parameters

  • paramsIn: any

  Returns Promise<any>

getUnsortedByUID

• getUnsortedByUID(uid): Promise<any>

• Parameters

  • uid: string

  Returns Promise<any>

getUserById

• getUserById(userId): Promise<any>

• Parameters

  • userId: number

  Returns Promise<any>

getUsers

• getUsers(): Promise<any>

• Returns Promise<any>

deleteWebhook

• deleteWebhook(__namedParameters): Promise<any>

• Parameters

  • __namedParameters: any

  Returns Promise<any>

getWebhooks

• getWebhooks(): Promise<any>

• Returns Promise<any>

setWebhook

• setWebhook(params): Promise<any>

• Parameters

  • params: WebhookParams

  Returns Promise<any>

getWidget

• getWidget(widgetCode): Promise<any>

• Parameters

  • widgetCode: string

  Returns Promise<any>

getWidgets

• getWidgets(params): Promise<any>

• Parameters

  • params: any

  Returns Promise<any>