Class AmoJoScopeClient

Index

Constructors

constructor

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

Methods

createChat

createChat(chatDto): Promise<any>
Parameters
- chatDto: any
Returns Promise<any>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:109

`Private` createCheckSum

createCheckSum(method, bodyContent): string
Parameters
- method: string
- bodyContent: string
Returns string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:90

`Private` createSignatureForRequestBody

createSignatureForRequestBody(body): string
Parameters
- body: string
Returns string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:86

`Private` getAudioMessage

getAudioMessage(params): {
    message: {
        media: any;
        text: any;
        type: string;
    };
}
Parameters
- params: any
Returns {
    message: {
        media: any;
        text: any;
        type: string;
    };
}
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:249

getChatDto

getChatDto(amojoUserId): {
    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;
    };
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- user: {
  ref_id: string;
  }
  - ref_id: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:96

getChatHistory

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

`Private` getConversationIds

getConversationIds(conversationId): {
conversation_id: `${string}-${string}-${string}-${string}-${string}`;
conversation_ref_id: string;
}
Parameters
- conversationId: string
Returns {
conversation_id: `${string}-${string}-${string}-${string}-${string}`;
conversation_ref_id: string;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:157

`Private` getImageMessage

getImageMessage(params): {
    message: {
        media: any;
        text: any;
        type: string;
    };
}
Parameters
- params: any
Returns {
    message: {
        media: any;
        text: any;
        type: string;
    };
}
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:229

`Private` getMessageDate

getMessageDate(): {
msec_timestamp: number;
timestamp: number;
}
Returns {
msec_timestamp: number;
timestamp: number;
}
- msec_timestamp: number
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:177

`Private` getMessageIdAndDate

getMessageIdAndDate(): {
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    timestamp: number;
}
Returns {
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    timestamp: number;
}
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:168

getQuoteImageMessage

getQuoteImageMessage(params): {
    reply_to: {
        message: {
            media: any;
            msec_timestamp: number;
            sender: {
                id: `${string}-${string}-${string}-${string}-${string}`;
                name: any;
            };
            text: any;
            timestamp: number;
            type: string;
        };
    };
}
Parameters
- params: any
Returns {
    reply_to: {
        message: {
            media: any;
            msec_timestamp: number;
            sender: {
                id: `${string}-${string}-${string}-${string}-${string}`;
                name: any;
            };
            text: any;
            timestamp: number;
            type: string;
        };
    };
}
- reply_to: {
      message: {
          media: any;
          msec_timestamp: number;
          sender: {
              id: `${string}-${string}-${string}-${string}-${string}`;
              name: any;
          };
          text: any;
          timestamp: number;
          type: string;
      };
  }
  - message: {
        media: any;
        msec_timestamp: number;
        sender: {
            id: `${string}-${string}-${string}-${string}-${string}`;
            name: any;
        };
        text: any;
        timestamp: number;
        type: string;
    }
    - media: any
    - msec_timestamp: number
    - sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: any;
      }
      - id: `${string}-${string}-${string}-${string}-${string}`
      - name: any
    - text: any
    - timestamp: number
    - type: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:318

`Private` getQuoteSender

getQuoteSender(params): {
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
}
Parameters
- params: any
Returns {
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
}
- sender: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: any
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:216

getQuoteTextMessage

getQuoteTextMessage(params): {
    reply_to: {
        message: {
            msec_timestamp: number;
            msgid: `${string}-${string}-${string}-${string}-${string}`;
            sender: {
                id: `${string}-${string}-${string}-${string}-${string}`;
                name: any;
            };
            text: any;
            timestamp: number;
            type: string;
        };
    };
}
Parameters
- params: any
Returns {
    reply_to: {
        message: {
            msec_timestamp: number;
            msgid: `${string}-${string}-${string}-${string}-${string}`;
            sender: {
                id: `${string}-${string}-${string}-${string}-${string}`;
                name: any;
            };
            text: any;
            timestamp: number;
            type: string;
        };
    };
}
- reply_to: {
      message: {
          msec_timestamp: number;
          msgid: `${string}-${string}-${string}-${string}-${string}`;
          sender: {
              id: `${string}-${string}-${string}-${string}-${string}`;
              name: any;
          };
          text: any;
          timestamp: number;
          type: string;
      };
  }
  - message: {
        msec_timestamp: number;
        msgid: `${string}-${string}-${string}-${string}-${string}`;
        sender: {
            id: `${string}-${string}-${string}-${string}-${string}`;
            name: any;
        };
        text: any;
        timestamp: number;
        type: string;
    }
    - msec_timestamp: number
    - msgid: `${string}-${string}-${string}-${string}-${string}`
    - sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: any;
      }
      - id: `${string}-${string}-${string}-${string}-${string}`
      - name: any
    - text: any
    - timestamp: number
    - type: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:306

getQuoteVideoMessage

getQuoteVideoMessage(params): {
    reply_to: {
        message: {
            media: any;
            msec_timestamp: number;
            sender: {
                id: `${string}-${string}-${string}-${string}-${string}`;
                name: any;
            };
            text: any;
            timestamp: number;
            type: string;
        };
    };
}
Parameters
- params: any
Returns {
    reply_to: {
        message: {
            media: any;
            msec_timestamp: number;
            sender: {
                id: `${string}-${string}-${string}-${string}-${string}`;
                name: any;
            };
            text: any;
            timestamp: number;
            type: string;
        };
    };
}
- reply_to: {
      message: {
          media: any;
          msec_timestamp: number;
          sender: {
              id: `${string}-${string}-${string}-${string}-${string}`;
              name: any;
          };
          text: any;
          timestamp: number;
          type: string;
      };
  }
  - message: {
        media: any;
        msec_timestamp: number;
        sender: {
            id: `${string}-${string}-${string}-${string}-${string}`;
            name: any;
        };
        text: any;
        timestamp: number;
        type: string;
    }
    - media: any
    - msec_timestamp: number
    - sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: any;
      }
      - id: `${string}-${string}-${string}-${string}-${string}`
      - name: any
    - text: any
    - timestamp: number
    - type: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:333

`Private` getSenderReceiverFromBot

getSenderReceiverFromBot(params): {
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
}
Parameters
- params: any
Returns {
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
}
- receiver: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: string;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
- sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: string;
      ref_id: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
  - ref_id: any
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:143

`Private` getSenderReceiverFromContact

getSenderReceiverFromContact(params): {
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
}
Parameters
- params: any
Returns {
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
}
- sender: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: any
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:207

`Private` getSenderRecieverFromUser

getSenderRecieverFromUser(params): {
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
}
Parameters
- params: any
Returns {
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
}
- receiver: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: string;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
- sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: string;
      ref_id: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
  - ref_id: any
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:193

`Private` getSilent

getSilent(silent): {
silent: boolean;
}
Parameters
- silent: boolean
Returns {
silent: boolean;
}
- silent: boolean
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:164

`Private` getSource

getSource(sourceExternalId): {
    source: {
        external_id: string;
    };
}
Parameters
- sourceExternalId: string
Returns {
    source: {
        external_id: string;
    };
}
- source: {
  external_id: string;
  }
  - external_id: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:185

`Private` getTextMessage

getTextMessage(params): {
    message: {
        text: any;
        type: string;
    };
}
Parameters
- params: any
Returns {
    message: {
        text: any;
        type: string;
    };
}
- message: {
  text: any;
  type: string;
  }
  - text: any
  - type: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:220

`Private` getVideoMessage

getVideoMessage(params): {
    message: {
        media: any;
        text: any;
        type: string;
    };
}
Parameters
- params: any
Returns {
    message: {
        media: any;
        text: any;
        type: string;
    };
}
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:239

sendMessage

sendMessage(payload): Promise<any>
Parameters
- payload: any
Returns Promise<any>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:113

`Private` sendRequest

sendRequest(method, url, options?): Promise<any>
Parameters
- method: string
- url: string
- Optional options: any
Returns Promise<any>
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:58

updateMessageStatus

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

Payloads Audio

getAudioPayloadFromBot

getAudioPayloadFromBot(params): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
Parameters
- params: ImagePayloadFromBotParams
Returns {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- receiver: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: string;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
- sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: string;
      ref_id: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
  - ref_id: any
- silent: boolean
- source: {
  external_id: string;
  }
  - external_id: string
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:443

getAudioPayloadFromContact

getAudioPayloadFromContact(params): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
Parameters
- params: ImagePayloadFromContactParams
Returns {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- sender: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: any
- silent: boolean
- source: {
  external_id: string;
  }
  - external_id: string
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:474

getAudioPayloadFromUser

getAudioPayloadFromUser(params): any
Parameters
- params: ImagePayloadFromUserParams
Returns any
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:458

Payloads Image

getImagePayloadFromBot

getImagePayloadFromBot(params): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
Parameters
- params: ImagePayloadFromBotParams
Returns {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- receiver: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: string;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
- sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: string;
      ref_id: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
  - ref_id: any
- silent: boolean
- source: {
  external_id: string;
  }
  - external_id: string
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:351

getImagePayloadFromContact

getImagePayloadFromContact(params): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
Parameters
- params: ImagePayloadFromContactParams
Returns {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- sender: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: any
- silent: boolean
- source: {
  external_id: string;
  }
  - external_id: string
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:382

getImagePayloadFromUser

getImagePayloadFromUser(params): any
Parameters
- params: ImagePayloadFromUserParams
Returns any
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:366

Payloads Text

getTextPayloadFromBot

getTextPayloadFromBot(params): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
Parameters
- params: TextPayloadFromBotParams
Returns {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- message: {
  text: any;
  type: string;
  }
  - text: any
  - type: string
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- receiver: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: string;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
- sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: string;
      ref_id: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
  - ref_id: any
- silent: boolean
- source: {
  external_id: string;
  }
  - external_id: string
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:263

getTextPayloadFromContact

getTextPayloadFromContact(params): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
Parameters
- params: TextPayloadFromContactParams
Returns {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- message: {
  text: any;
  type: string;
  }
  - text: any
  - type: string
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- sender: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: any
- silent: boolean
- source: {
  external_id: string;
  }
  - external_id: string
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:294

getTextPayloadFromUser

getTextPayloadFromUser(params): any
Parameters
- params: TextPayloadFromUserParams
Returns any
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:279

Payloads Video

getVideoPayloadFromBot

getVideoPayloadFromBot(params): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
Parameters
- params: ImagePayloadFromBotParams
Returns {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    receiver: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
    };
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: string;
        ref_id: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- receiver: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: string;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
- sender: {
      id: `${string}-${string}-${string}-${string}-${string}`;
      name: string;
      ref_id: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: string
  - ref_id: any
- silent: boolean
- source: {
  external_id: string;
  }
  - external_id: string
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:397

getVideoPayloadFromContact

getVideoPayloadFromContact(params): {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
Parameters
- params: ImagePayloadFromContactParams
Returns {
    conversation_id: `${string}-${string}-${string}-${string}-${string}`;
    conversation_ref_id: string;
    message: {
        media: any;
        text: any;
        type: string;
    };
    msec_timestamp: number;
    msgid: `${string}-${string}-${string}-${string}-${string}`;
    sender: {
        id: `${string}-${string}-${string}-${string}-${string}`;
        name: any;
    };
    silent: boolean;
    source: {
        external_id: string;
    };
    timestamp: number;
}
- conversation_id: `${string}-${string}-${string}-${string}-${string}`
- conversation_ref_id: string
- message: {
      media: any;
      text: any;
      type: string;
  }
  - media: any
  - text: any
  - type: string
- msec_timestamp: number
- msgid: `${string}-${string}-${string}-${string}-${string}`
- sender: {
  id: `${string}-${string}-${string}-${string}-${string}`;
  name: any;
  }
  - id: `${string}-${string}-${string}-${string}-${string}`
  - name: any
- silent: boolean
- source: {
  external_id: string;
  }
  - external_id: string
- timestamp: number
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:428

getVideoPayloadFromUser

getVideoPayloadFromUser(params): any
Parameters
- params: ImagePayloadFromUserParams
Returns any
- Defined in AmoJoScopeClient/AmoJoScopeClient.ts:412

Properties

amoChatDomain

amoChatDomain: string

channelSecret

channelSecret: string

instance

instance: AxiosInstance

scopeId

scopeId: string

Class AmoJoScopeClient

Index

Constructors

Methods

Payloads Audio

Payloads Image

Payloads Text

Payloads Video

Properties

Constructors

constructor

Parameters

Returns AmoJoScopeClient

Methods

createChat

Parameters

Returns Promise<any>

Private createCheckSum

Parameters

Returns string

Private createSignatureForRequestBody

Parameters

Returns string

Private getAudioMessage

Parameters

Returns { message: { media: any; text: any; type: string; }; }

message: { media: any; text: any; type: string; }

media: any

text: any

type: string

getChatDto

Parameters

Returns { conversation_id: `${string}-${string}-${string}-${string}-${string}`; user: { ref_id: string; }; }

conversation_id: `${string}-${string}-${string}-${string}-${string}`

user: { ref_id: string; }

ref_id: string

getChatHistory

Parameters

Returns Promise<any>

Private getConversationIds

Parameters

Returns { conversation_id: `${string}-${string}-${string}-${string}-${string}`; conversation_ref_id: string; }

conversation_id: `${string}-${string}-${string}-${string}-${string}`

conversation_ref_id: string

Private getImageMessage

Parameters

Returns { message: { media: any; text: any; type: string; }; }

message: { media: any; text: any; type: string; }

media: any

text: any

type: string

Private getMessageDate

Returns { msec_timestamp: number; timestamp: number; }

msec_timestamp: number

timestamp: number

Private getMessageIdAndDate

Returns { msec_timestamp: number; msgid: `${string}-${string}-${string}-${string}-${string}`; timestamp: number; }

msec_timestamp: number

msgid: `${string}-${string}-${string}-${string}-${string}`

timestamp: number

getQuoteImageMessage

Parameters

Returns { reply_to: { message: { media: any; msec_timestamp: number; sender: { id: `${string}-${string}-${string}-${string}-${string}`; name: any; }; text: any; timestamp: number; type: string; }; }; }

reply_to: { message: { media: any; msec_timestamp: number; sender: { id: `${string}-${string}-${string}-${string}-${string}`; name: any; }; text: any; timestamp: number; type: string; }; }

message: { media: any; msec_timestamp: number; sender: { id: `${string}-${string}-${string}-${string}-${string}`; name: any; }; text: any; timestamp: number; type: string; }

media: any

msec_timestamp: number

sender: { id: `${string}-${string}-${string}-${string}-${string}`; name: any; }

id: `${string}-${string}-${string}-${string}-${string}`

name: any

text: any

timestamp: number

type: string

Private getQuoteSender

Parameters

Returns { sender: { id: `${string}-${string}-${string}-${string}-${string}`; name: any; }; }

sender: { id: `${string}-${string}-${string}-${string}-${string}`; name: any; }

id: `${string}-${string}-${string}-${string}-${string}`

name: any

getQuoteTextMessage

`Private` createCheckSum

`Private` createSignatureForRequestBody

`Private` getAudioMessage

Returns {
message: {
media: any;
text: any;
type: string;
};
}

message: {
media: any;
text: any;
type: string;
}

Returns {
conversation_id: `${string}-${string}-${string}-${string}-${string}`;
user: {
ref_id: string;
};
}

user: {
ref_id: string;
}

`Private` getConversationIds

Returns {
conversation_id: `${string}-${string}-${string}-${string}-${string}`;
conversation_ref_id: string;
}

`Private` getImageMessage

Returns {
message: {
media: any;
text: any;
type: string;
};
}

message: {
media: any;
text: any;
type: string;
}

`Private` getMessageDate

Returns {
msec_timestamp: number;
timestamp: number;
}

`Private` getMessageIdAndDate

Returns {
msec_timestamp: number;
msgid: `${string}-${string}-${string}-${string}-${string}`;
timestamp: number;
}

Returns {
reply_to: {
message: {
media: any;
msec_timestamp: number;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
};
};
}

reply_to: {
message: {
media: any;
msec_timestamp: number;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
};
}

message: {
media: any;
msec_timestamp: number;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
}

sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
}

`Private` getQuoteSender

Returns {
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
}

sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
}

Returns {
reply_to: {
message: {
msec_timestamp: number;
msgid: `${string}-${string}-${string}-${string}-${string}`;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
};
};
}

reply_to: {
message: {
msec_timestamp: number;
msgid: `${string}-${string}-${string}-${string}-${string}`;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
};
}

message: {
msec_timestamp: number;
msgid: `${string}-${string}-${string}-${string}-${string}`;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
}

sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
}

Returns {
reply_to: {
message: {
media: any;
msec_timestamp: number;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
};
};
}

reply_to: {
message: {
media: any;
msec_timestamp: number;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
};
}

message: {
media: any;
msec_timestamp: number;
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
text: any;
timestamp: number;
type: string;
}

sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
}

`Private` getSenderReceiverFromBot

Returns {
receiver: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: string;
};
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: string;
ref_id: any;
};
}

receiver: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: string;
}

sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: string;
ref_id: any;
}

`Private` getSenderReceiverFromContact

Returns {
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
};
}

sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: any;
}

`Private` getSenderRecieverFromUser

Returns {
receiver: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: string;
};
sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: string;
ref_id: any;
};
}

receiver: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: string;
}

sender: {
id: `${string}-${string}-${string}-${string}-${string}`;
name: string;
ref_id: any;
}

`Private` getSilent

Returns {
silent: boolean;
}

`Private` getSource

Returns {
source: {
external_id: string;
};
}

source: {
external_id: string;
}

`Private` getTextMessage

Returns {
message: {
text: any;
type: string;
};
}

message: {
text: any;
type: string;
}

`Private` getVideoMessage

Returns {
message: {
media: any;
text: any;
type: string;
};
}

message: {
media: any;
text: any;
type: string;
}