Class GupshupAPIClient

constructor

• new GupshupAPIClient(__namedParameters): GupshupAPIClient

• Parameters

  • __namedParameters: GupshupAPIClientConfig

  Returns GupshupAPIClient

checkContentType

• checkContentType(type, contentType): boolean

• Parameters

  • type: string
  • contentType: string

  Returns boolean

checkSize

• checkSize(type, size): boolean

• Parameters

  • type: string
  • size: number

  Returns boolean

getReadStatus

• getReadStatus(msgid): Promise<AxiosResponse<any, any>>

• Parameters

  • msgid: string

  Returns Promise<AxiosResponse<any, any>>

getTemplatesList

• getTemplatesList(): Promise<AxiosResponse<any, any>>

• Returns Promise<AxiosResponse<any, any>>

getUrlEncodedData

• getUrlEncodedData(data): URLSearchParams

• Parameters

  • data: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns URLSearchParams

markRead

• markRead(msgid): Promise<AxiosResponse<any, any>>

• Parameters

  • msgid: string

  Returns Promise<AxiosResponse<any, any>>

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>>

setReadStatus

• setReadStatus(msgid): Promise<AxiosResponse<any, any>>

• Parameters

  • msgid: string

  Returns Promise<AxiosResponse<any, any>>

API_KEY

APP_ID

APP_NAME

SOURCE_MOBILE_NUMBER

axios

debug