Class GupshupAPIClient

Constructors

constructor

Methods

checkContentType checkSize getOptInUsersList getTemplatesList getUrlEncodedData getWalletBalance markBulkOptIn markRead markUserOptIn sendContactCard sendListMessage sendLocation sendMediaAudioMessage sendMediaFileMessage sendMediaImageMessage sendMediaStickerMessage sendMediaVideoMessage sendQuickReply sendTemplateDocumentMessage sendTemplateImageMessage sendTemplateLocationMessage sendTemplateTextMessage sendTemplateVideoMessage sendTextMessage

Properties

API_KEY APP_ID? APP_NAME SOURCE_MOBILE_NUMBER config url

Constructors

constructor

Methods

checkContentType

checkSize

getOptInUsersList

getTemplatesList

getUrlEncodedData

getWalletBalance

markBulkOptIn

markRead

markUserOptIn

sendContactCard

  • sendContactCard(userMobileNumber, contact): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • contact: ContactCard

    Returns Promise<AxiosResponse<any, any>>

sendListMessage

  • sendListMessage(userMobileNumber, message): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • message: ListMessage

    Returns Promise<AxiosResponse<any, any>>

sendLocation

  • sendLocation(userMobileNumber, longitude, latitude, name, address): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • longitude: string
    • latitude: string
    • name: string
    • address: string

    Returns Promise<AxiosResponse<any, any>>

sendMediaAudioMessage

  • sendMediaAudioMessage(userMobileNumber, audioUrl): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • audioUrl: string

    Returns Promise<AxiosResponse<any, any>>

sendMediaFileMessage

  • sendMediaFileMessage(userMobileNumber, fileUrl, filename): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • fileUrl: string
    • filename: string

    Returns Promise<AxiosResponse<any, any>>

sendMediaImageMessage

  • sendMediaImageMessage(userMobileNumber, imageUrl, caption): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • imageUrl: string
    • caption: string

    Returns Promise<AxiosResponse<any, any>>

sendMediaStickerMessage

  • sendMediaStickerMessage(userMobileNumber, stickerUrl): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • stickerUrl: string

    Returns Promise<AxiosResponse<any, any>>

sendMediaVideoMessage

  • sendMediaVideoMessage(userMobileNumber, videoUrl, caption): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • videoUrl: string
    • caption: string

    Returns Promise<AxiosResponse<any, any>>

sendQuickReply

  • sendQuickReply(userMobileNumber, message): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • message: QuickReplyMessage

    Returns Promise<AxiosResponse<any, any>>

sendTemplateDocumentMessage

  • sendTemplateDocumentMessage(userMobileNumber, templateId, templateParams, documentUrl, filename): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • templateId: string
    • templateParams: string[]
    • documentUrl: string
    • filename: string

    Returns Promise<AxiosResponse<any, any>>

sendTemplateImageMessage

  • sendTemplateImageMessage(userMobileNumber, templateId, templateParams, imageUrl): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • templateId: string
    • templateParams: string[]
    • imageUrl: string

    Returns Promise<AxiosResponse<any, any>>

sendTemplateLocationMessage

  • sendTemplateLocationMessage(userMobileNumber, templateId, templateParams, longitude, latitude): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • templateId: string
    • templateParams: string[]
    • longitude: string
    • latitude: string

    Returns Promise<AxiosResponse<any, any>>

sendTemplateTextMessage

  • sendTemplateTextMessage(userMobileNumber, templateId, templateParams): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • templateId: string
    • templateParams: string[]

    Returns Promise<AxiosResponse<any, any>>

sendTemplateVideoMessage

  • sendTemplateVideoMessage(userMobileNumber, templateId, templateParams, videoUrl): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • templateId: string
    • templateParams: string[]
    • videoUrl: string

    Returns Promise<AxiosResponse<any, any>>

sendTextMessage

  • sendTextMessage(userMobileNumber, message): Promise<AxiosResponse<any, any>>

  • Parameters

    • userMobileNumber: string
    • message: string

    Returns Promise<AxiosResponse<any, any>>

Properties

API_KEY

API_KEY: string

Optional APP_ID

APP_ID?: string

APP_NAME

APP_NAME: string

SOURCE_MOBILE_NUMBER

SOURCE_MOBILE_NUMBER: string

config

config: {
    headers: {
        Cache-Control: string;
        Content-Type: string;
        apiKey: string;
    };
}

Type declaration

  • headers: {
        Cache-Control: string;
        Content-Type: string;
        apiKey: string;
    }
    • Cache-Control: string
    • Content-Type: string
    • apiKey: string

url

url: {
    bulkOptIn: string;
    getTemplatesList: string;
    getWalletBalance: string;
    optInUser: string;
    optInUsersList: string;
    sendTemplateMessage: string;
    sendTextMessage: string;
}

Type declaration

  • bulkOptIn: string
  • getTemplatesList: string
  • getWalletBalance: string
  • optInUser: string
  • optInUsersList: string
  • sendTemplateMessage: string
  • sendTextMessage: string

Settings

Member Visibility

Theme

On This Page

constructorcheckContentTypecheckSizegetOptInUsersListgetTemplatesListgetUrlEncodedDatagetWalletBalancemarkBulkOptInmarkReadmarkUserOptInsendContactCardsendListMessagesendLocationsendMediaAudioMessagesendMediaFileMessagesendMediaImageMessagesendMediaStickerMessagesendMediaVideoMessagesendQuickReplysendTemplateDocumentMessagesendTemplateImageMessagesendTemplateLocationMessagesendTemplateTextMessagesendTemplateVideoMessagesendTextMessageAPI_KEYAPP_IDAPP_NAMESOURCE_MOBILE_NUMBERconfigurl

Generated using TypeDoc