Class AmoJoScopeClient

Constructors

constructor

new AmoJoScopeClient(options: AmoJoScopeClientOptions): AmoJoScopeClient
Parameters
- options: AmoJoScopeClientOptions
Returns AmoJoScopeClient
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:22

Methods

createChat

createChat(chatDto: Record<string, unknown>): Promise<any>
Parameters
- chatDto: Record<string, unknown>
Returns Promise<any>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:115

getAmoChatDomain

getAmoChatDomain(): string
Returns string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:63

getChatDto

getChatDto(
    amojoUserId: string,
): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    user: { ref_id: string };
}
Parameters
- amojoUserId: string
Returns {
conversation_id: `${string}-${string}-${string}-${string}-${string}`;
user: { ref_id: string };
}
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:104

getChatHistory

getChatHistory(conversationId: string): Promise<any>
Parameters
- conversationId: string
Returns Promise<any>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:127

getQuoteImageMessage

getQuoteImageMessage(
params: { mediaUrl: string; senderName: string },
): Record<string, unknown>
Parameters
- params: { mediaUrl: string; senderName: string }
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:334

getQuoteTextMessage

getQuoteTextMessage(
params: { message: string; senderName: string },
): Record<string, unknown>
Parameters
- params: { message: string; senderName: string }
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:322

getQuoteVideoMessage

getQuoteVideoMessage(
params: { mediaUrl: string; senderName: string },
): Record<string, unknown>
Parameters
- params: { mediaUrl: string; senderName: string }
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:349

getScopeId

getScopeId(): string
Returns string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:59

sendMessage

sendMessage(payload: Record<string, unknown>): Promise<any>
Parameters
- payload: Record<string, unknown>
Returns Promise<any>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:119

updateMessageStatus

updateMessageStatus(
    msgid: string,
    deliveryStatus: DeliveryStatusEnum,
    errorCode?: number,
    error?: string,
): Promise<any>
Parameters
- msgid: string
- deliveryStatus: DeliveryStatusEnum
- OptionalerrorCode: number
- Optionalerror: string
Returns Promise<any>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:131

Payloads Audio

getAudioPayloadFromBot

getAudioPayloadFromBot(
params: ImagePayloadFromBotParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromBotParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:493

getAudioPayloadFromContact

getAudioPayloadFromContact(
params: ImagePayloadFromContactParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromContactParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:535

getAudioPayloadFromUser

getAudioPayloadFromUser(
params: ImagePayloadFromUserParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromUserParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:514

Payloads Image

getImagePayloadFromBot

getImagePayloadFromBot(
params: ImagePayloadFromBotParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromBotParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:367

getImagePayloadFromContact

getImagePayloadFromContact(
params: ImagePayloadFromContactParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromContactParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:409

getImagePayloadFromUser

getImagePayloadFromUser(
params: ImagePayloadFromUserParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromUserParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:388

Payloads Text

getTextPayloadFromBot

getTextPayloadFromBot(params: TextPayloadFromBotParams): Record<string, unknown>
Parameters
- params: TextPayloadFromBotParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:262

getTextPayloadFromContact

getTextPayloadFromContact(
params: TextPayloadFromContactParams,
): Record<string, unknown>
Parameters
- params: TextPayloadFromContactParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:304

getTextPayloadFromUser

getTextPayloadFromUser(
params: TextPayloadFromUserParams,
): Record<string, unknown>
Parameters
- params: TextPayloadFromUserParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:283

Payloads Video

getVideoPayloadFromBot

getVideoPayloadFromBot(
params: ImagePayloadFromBotParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromBotParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:430

getVideoPayloadFromContact

getVideoPayloadFromContact(
params: ImagePayloadFromContactParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromContactParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:472

getVideoPayloadFromUser

getVideoPayloadFromUser(
params: ImagePayloadFromUserParams,
): Record<string, unknown>
Parameters
- params: ImagePayloadFromUserParams
Returns Record<string, unknown>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:451