Class AmoJoScopeClient

constructor

• new AmoJoScopeClient(options): AmoJoScopeClient

• Parameters

  • options: AmoJoScopeClientOptions

  Returns AmoJoScopeClient

createChat

• createChat(chatDto): Promise<any>

• Parameters

  • chatDto: any

  Returns Promise<any>

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

getChatHistory

• getChatHistory(conversationId): Promise<any>

• Parameters

  • conversationId: string

  Returns Promise<any>

sendMessage

• sendMessage(payload): Promise<any>

• Parameters

  • payload: any

  Returns Promise<any>

updateMessageStatus

• updateMessageStatus(msgid, deliveryStatus, errorCode?, error?): Promise<any>

• Parameters

  • msgid: string

  • deliveryStatus: DeliveryStatusEnum

  • Optional errorCode: number

  • Optional error: string

  Returns Promise<any>

getImagePayloadToContact

• getImagePayloadToContact(params): {
      conversation_id: `${string}-${string}-${string}-${string}-${string}`;
      conversation_ref_id: string;
      message: {
          media: string;
          text: string;
          type: string;
      };
      msec_timestamp: number;
      msgid: `${string}-${string}-${string}-${string}-${string}`;
      sender: {
          id: `${string}-${string}-${string}-${string}-${string}`;
          name: string;
      };
      silent: boolean;
  }

• Parameters

  • params: ImagePayloadToContactParams

  Returns {
      conversation_id: `${string}-${string}-${string}-${string}-${string}`;
      conversation_ref_id: string;
      message: {
          media: string;
          text: string;
          type: string;
      };
      msec_timestamp: number;
      msgid: `${string}-${string}-${string}-${string}-${string}`;
      sender: {
          id: `${string}-${string}-${string}-${string}-${string}`;
          name: string;
      };
      silent: boolean;
  }

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

  • conversation_ref_id: string

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

    • media: string

    • text: string

    • type: string

  • msec_timestamp: number

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

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

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

    • name: string

  • silent: boolean

getTextPayloadFromBot

• getTextPayloadFromBot(params): {
      conversation_id: `${string}-${string}-${string}-${string}-${string}`;
      conversation_ref_id: string;
      message: {
          text: string;
          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: string;
      };
      silent: boolean;
  }

• Parameters

  • params: TextPayloadFromBotParams

  Returns {
      conversation_id: `${string}-${string}-${string}-${string}-${string}`;
      conversation_ref_id: string;
      message: {
          text: string;
          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: string;
      };
      silent: boolean;
  }

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

  • conversation_ref_id: string

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

    • text: string

    • 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: string;
    }

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

    • name: string

    • ref_id: string

  • silent: boolean

getTextPayloadFromUser

• getTextPayloadFromUser(params): {
      conversation_id: `${string}-${string}-${string}-${string}-${string}`;
      conversation_ref_id: string;
      message: {
          text: string;
          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: string;
      };
      silent: boolean;
  }

• Parameters

  • params: TextPayloadFromUserParams

  Returns {
      conversation_id: `${string}-${string}-${string}-${string}-${string}`;
      conversation_ref_id: string;
      message: {
          text: string;
          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: string;
      };
      silent: boolean;
  }

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

  • conversation_ref_id: string

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

    • text: string

    • 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: string;
    }

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

    • name: string

    • ref_id: string

  • silent: boolean

getTextPayloadToContact

• getTextPayloadToContact(params): {
      conversation_id: `${string}-${string}-${string}-${string}-${string}`;
      conversation_ref_id: string;
      message: {
          text: string;
          type: string;
      };
      msec_timestamp: number;
      msgid: `${string}-${string}-${string}-${string}-${string}`;
      sender: {
          id: `${string}-${string}-${string}-${string}-${string}`;
          name: string;
      };
      silent: boolean;
  }

• Parameters

  • params: TextPayloadToContactParams

  Returns {
      conversation_id: `${string}-${string}-${string}-${string}-${string}`;
      conversation_ref_id: string;
      message: {
          text: string;
          type: string;
      };
      msec_timestamp: number;
      msgid: `${string}-${string}-${string}-${string}-${string}`;
      sender: {
          id: `${string}-${string}-${string}-${string}-${string}`;
          name: string;
      };
      silent: boolean;
  }

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

  • conversation_ref_id: string

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

    • text: string

    • type: string

  • msec_timestamp: number

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

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

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

    • name: string

  • silent: boolean

amoChatDomain

channelSecret

instance

scopeId