Class GupshupAPIClient

Index

Bussiness Profile

getBusinessDetails getBusinessProfileAbout getBusinessProfileDetails getBusinessProfilePhoto updateBusinessProfileAbout updateBusinessProfileDetails updateBusinessProfilePhoto

Constructors

Message Read Status

getReadStatus markRead

Message Read Status alias {@link markRead}

Methods

checkContentType checkSize getUrlEncodedData

Opt In

getOptInUsersList markUserOptIn

Properties

API_KEY APP_ID APP_NAME axios debug SOURCE_MOBILE_NUMBER

Session Message

sendContactCard sendListMessage sendLocation sendMediaAudioMessage sendMediaFileMessage sendMediaImageMessage sendMediaStickerMessage sendMediaVideoMessage sendQuickReply sendTextMessage

Subscription

addSubscription deleteAllSubscriptions deleteSubscription getSubscription updateSubscription

Template

getTemplateById getTemplatesList

Template Message

sendTemplateDocumentMessage sendTemplateImageMessage sendTemplateLocationMessage sendTemplateTextMessage sendTemplateVideoMessage

Bussiness Profile

getBusinessDetails

getBusinessDetails(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:164

getBusinessProfileAbout

getBusinessProfileAbout(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:172

getBusinessProfileDetails

getBusinessProfileDetails(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:189

getBusinessProfilePhoto

getBusinessProfilePhoto(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:205

updateBusinessProfileAbout

updateBusinessProfileAbout(about: string): Promise<AxiosResponse<any, any>>
Parameters
- about: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:180

updateBusinessProfileDetails

updateBusinessProfileDetails(
data: BusinessProfileDetails,
): Promise<AxiosResponse<any, any>>
Parameters
- data: BusinessProfileDetails
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:197

updateBusinessProfilePhoto

updateBusinessProfilePhoto(file: any): Promise<AxiosResponse<any, any>>
Parameters
- file: any
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:213

Constructors

constructor

new GupshupAPIClient(
__namedParameters: GupshupAPIClientConfig,
): GupshupAPIClient
Parameters
- __namedParameters: GupshupAPIClientConfig
Returns GupshupAPIClient
- Defined in GupshupApiClient/GupshupApiClient.ts:34

Message Read Status

getReadStatus

getReadStatus(msgid: string): Promise<AxiosResponse<any, any>>
Parameters
- msgid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:252

markRead

markRead(msgid: string): Promise<AxiosResponse<any, any>>
Parameters
- msgid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:230

Message Read Status alias {@link markRead}

setReadStatus

setReadStatus(msgid: string): Promise<AxiosResponse<any, any>>
Parameters
- msgid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:245

Methods

checkContentType

checkContentType(type: string, contentType: string): boolean
Parameters
- type: string
- contentType: string
Returns boolean
- Defined in GupshupApiClient/GupshupApiClient.ts:594

checkSize

checkSize(type: string, size: number): boolean
Parameters
- type: string
- size: number
Returns boolean
- Defined in GupshupApiClient/GupshupApiClient.ts:604

getUrlEncodedData

getUrlEncodedData(data: { [key: string]: any }): URLSearchParams
Parameters
- data: { [key: string]: any }
Returns URLSearchParams
- Defined in GupshupApiClient/GupshupApiClient.ts:75

Opt In

getOptInUsersList

getOptInUsersList(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
Deprecated
- Defined in GupshupApiClient/GupshupApiClient.ts:156

markUserOptIn

markUserOptIn(userMobileNumber: string): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
Returns Promise<AxiosResponse<any, any>>
Deprecated
- Defined in GupshupApiClient/GupshupApiClient.ts:143

Properties

API_KEY

API_KEY: string

APP_ID

APP_ID: string

APP_NAME

APP_NAME: string

axios

axios: AxiosInstance

debug

debug: boolean

SOURCE_MOBILE_NUMBER

SOURCE_MOBILE_NUMBER: string

Session Message

sendContactCard

sendContactCard(
userMobileNumber: string,
contact: ContactCard,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- contact: ContactCard
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:406

sendListMessage

sendListMessage(
userMobileNumber: string,
message: ListMessage,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- message: ListMessage
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:424

sendLocation

sendLocation(
    userMobileNumber: string,
    longitude: string,
    latitude: string,
    name: string,
    address: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- longitude: string
- latitude: string
- name: string
- address: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:379

sendMediaAudioMessage

sendMediaAudioMessage(
    userMobileNumber: string,
    audioUrl: string,
    caption: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- audioUrl: string
- caption: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:303

sendMediaFileMessage

sendMediaFileMessage(
    userMobileNumber: string,
    fileUrl: string,
    filename: string,
    caption: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- fileUrl: string
- filename: string
- caption: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:322

sendMediaImageMessage

sendMediaImageMessage(
    userMobileNumber: string,
    imageUrl: string,
    caption: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- imageUrl: string
- caption: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:264

sendMediaStickerMessage

sendMediaStickerMessage(
userMobileNumber: string,
stickerUrl: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- stickerUrl: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:342

sendMediaVideoMessage

sendMediaVideoMessage(
    userMobileNumber: string,
    videoUrl: string,
    caption: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- videoUrl: string
- caption: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:284

sendQuickReply

sendQuickReply(
userMobileNumber: string,
message: QuickReplyMessage,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- message: QuickReplyMessage
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:446

sendTextMessage

sendTextMessage(
userMobileNumber: string,
message: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- message: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:360

Subscription

addSubscription

addSubscription(data: SubscriptionDataAdd): Promise<AxiosResponse<any, any>>
Parameters
- data: SubscriptionDataAdd
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:110

deleteAllSubscriptions

deleteAllSubscriptions(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:134

deleteSubscription

deleteSubscription(subscriptionId: string): Promise<AxiosResponse<any, any>>
Parameters
- subscriptionId: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:126

getSubscription

getSubscription(subscriptionId: string): Promise<AxiosResponse<any, any>>
Parameters
- subscriptionId: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:102

updateSubscription

updateSubscription(
subscriptionId: string,
data: SubscriptionDataUpdate,
): Promise<AxiosResponse<any, any>>
Parameters
- subscriptionId: string
- data: SubscriptionDataUpdate
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:118

Template

getTemplateById

getTemplateById(templateId: string): Promise<AxiosResponse<any, any>>
Parameters
- templateId: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:94

getTemplatesList

getTemplatesList(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:86

Template Message

sendTemplateDocumentMessage

sendTemplateDocumentMessage(
    userMobileNumber: string,
    templateId: string,
    templateParams: string[],
    documentUrl: string,
    filename: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- templateId: string
- templateParams: string[]
- documentUrl: string
- filename: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:538

sendTemplateImageMessage

sendTemplateImageMessage(
    userMobileNumber: string,
    templateId: string,
    templateParams: string[],
    imageUrl: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- templateId: string
- templateParams: string[]
- imageUrl: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:484

sendTemplateLocationMessage

sendTemplateLocationMessage(
    userMobileNumber: string,
    templateId: string,
    templateParams: string[],
    longitude: string,
    latitude: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- templateId: string
- templateParams: string[]
- longitude: string
- latitude: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:567

sendTemplateTextMessage

sendTemplateTextMessage(
    userMobileNumber: string,
    templateId: string,
    templateParams: string[],
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- templateId: string
- templateParams: string[]
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:466

sendTemplateVideoMessage

sendTemplateVideoMessage(
    userMobileNumber: string,
    templateId: string,
    templateParams: string[],
    videoUrl: string,
): Promise<AxiosResponse<any, any>>
Parameters
- userMobileNumber: string
- templateId: string
- templateParams: string[]
- videoUrl: string
Returns Promise<AxiosResponse<any, any>>
- Defined in GupshupApiClient/GupshupApiClient.ts:511