For the complete documentation index, see llms.txt. This page is also available as Markdown.

Account (Account)

Get Balance

API Request

GET

https://api.innopaas.com/api/whatsapp/v3/account/getBalance

Response Parameters

Field
Data Type
Required
Description

payType

Integer

Yes

1: Prepaid account, 2: Postpaid account

preBalance

Double

Yes

Prepaid balance, when payType=1, verify balance

postBalance

Double

Yes

Postpaid credit balance, when payType=2, verify balance; if isCreditUnlimit=1, the credit limit is unlimited

isCreditUnlimit

Integer

Yes

Whether postpaid credit is limited, 0: Limited, 1: Unlimited

Response Example

{
    "code": "0",
    "message": "Success",
    "data": {
        "payType": "",
        "preBalance": "innopaas street1.",
        "postBalance": "my test2",
        "isCreditUnlimit": "admin@innopaas.com",
        }
}

Authorize Waba to InnoPaaS

API Request

POST

https://api.innopaas.com/api/whatsapp/v3/business/authorized

Request Parameters

Field
Data Type
Required
Description

event

String

Yes

Authorization event: Business App authorization FINISH_WHATSAPP_BUSINESS_APP_ONBOARDING Waba Sender authorization FINISH_WHATSAPP_BUSINESS_PHONE_ONBOARDING MMLITE authorization FINISH_WHATSAPP_MMLITE_ONBOARDING ADS advertising authorization FINISH_WHATSAPP_ADS_ONBOARDING

type

String

Yes

Fixed value: WA_EMBEDDED_SIGNUP

code

String

Yes

Authorization code

data

Object

Yes

Specific authorization information

--waba_id

String

No

Waba Id, required for Business App authorization, Waba Sender authorization*

--phone_number_id

String

No

Bound phone number Id, required for Business App authorization, Waba Sender authorization*

--business_id

String

No

BS enterprise ID, required when Business App authorization, Waba Sender authorization, MMLITE authorization,Required

--waba_ids

String

No

Waba Id list, when MMLITE authorization,Required

--page_ids

String

No

Page ID list, required for CTWA and PageId authorization

--dataset_ids

String

No

Data set ID list.Required for CTWA and dataset authorization

--catalog_ids

String

No

Catalog ID list.Required for CTWA and dataset authorization

Request Example

Response Example

Get Waba List Information

API Request

POST

https://api.innopaas.com/api/whatsapp/v3/account/wabaInfo

Response Parameters

Field
Data Type
Required
Description

wabaId

String

Yes

Unique identifier of the WhatsApp business account

wabaName

String

Yes

WhatsApp business account name

wabaStatus

String

Yes

StatusPENDINGUnder ReviewAPPROVEDApprovedREJECTEDRejectedPAUSEDPausedDISABLEDDisabled

Response Example

Get Waba Number Information

API Request

POST

https://api.innopaas.com/api/whatsapp/v3/account/phoneInfo

Request Parameters

Field
Data Type
Required
Description

wabaId

String

Yes

Unique identifier of the WhatsApp business account

Request Example

Response Parameters

Field
Data Type
Required
Description

id

String

Yes

Phone number ID

displayPhoneNumber

String

Yes

Display number

verifiedName

String

Yes

Name

status

String

Yes

Number status

qualityRating

String

Yes

Number quality

messageLimit

String

Yes

Message limit

Response Example

最后更新于