Whatsapp Business API (v0.2.3)

Download OpenAPI specification:Download

This is a Unofficial Whatsapp Business Server API

Authentication

ApiKeyAuth

Security Scheme Type	API Key
Header parameter name:	Authorization

BasicAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

account

Log out Account

Log out Account and remove from database

Authorizations:

ApiKeyAuth

Responses

Response samples

Content type

application/json

{"data": null,
"message": "string",
"success": true,
"timestamp": "string"
}

Get List of Accounts

Responses

Response samples

Content type

application/json

{"data": [{"account": {"accountSignature": [0
],
"accountSignatureKey": [0
],
"details": [0
],
"deviceSignature": [0
]
},
"advSecretKey": [0
],
"appState": null,
"appStateKeys": null,
"businessName": "string",
"chatSettings": null,
"contacts": null,
"container": null,
"id": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"identities": null,
"identityKey": {"priv": [0
],
"pub": [0
]
},
"initialized": true,
"log": null,
"noiseKey": {"priv": [0
],
"pub": [0
]
},
"platform": "string",
"preKeys": null,
"pushName": "string",
"registrationID": 0,
"senderKeys": null,
"sessions": null,
"signedPreKey": {"keyID": 0,
"priv": [0
],
"pub": [0
],
"signature": [0
]
}
}
],
"message": "string",
"success": true,
"timestamp": "string"
}

Init Account

Authorizations:

BasicAuth

Request Body schema: application/json

Account

id	string
webhook_url	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"webhook_url": "string"
}

Response samples

Content type

application/json

{"data": {"code": "string",
"id": "string",
"image": "string",
"jid": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"token": "string"
},
"message": "string",
"success": true,
"timestamp": "string"
}

Get Account by ID

Authorizations:

ApiKeyAuth

path Parameters

required

string

Account ID

Responses

Response samples

Content type

application/json

{"data": [{"account": {"accountSignature": [0
],
"accountSignatureKey": [0
],
"details": [0
],
"deviceSignature": [0
]
},
"advSecretKey": [0
],
"appState": null,
"appStateKeys": null,
"businessName": "string",
"chatSettings": null,
"contacts": null,
"container": null,
"id": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"identities": null,
"identityKey": {"priv": [0
],
"pub": [0
]
},
"initialized": true,
"log": null,
"noiseKey": {"priv": [0
],
"pub": [0
]
},
"platform": "string",
"preKeys": null,
"pushName": "string",
"registrationID": 0,
"senderKeys": null,
"sessions": null,
"signedPreKey": {"keyID": 0,
"priv": [0
],
"pub": [0
],
"signature": [0
]
}
}
],
"message": "string",
"success": true,
"timestamp": "string"
}

Get Account Status

Authorizations:

ApiKeyAuth

Responses

Response samples

Content type

application/json

{"data": null,
"message": "string",
"success": true,
"timestamp": "string"
}

chats

Get all groups

Authorizations:

ApiKeyAuth

Responses

Response samples

Content type

application/json

{"data": [{"announceVersionID": "string",
"disappearingTimer": 0,
"groupCreated": "string",
"isAnnounce": true,
"isEphemeral": true,
"isLocked": true,
"jid": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"name": "string",
"nameSetAt": "string",
"nameSetBy": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"ownerJID": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"participantVersionID": "string",
"participants": [{"isAdmin": true,
"isSuperAdmin": true,
"jid": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
}
}
],
"topic": "string",
"topicID": "string",
"topicSetAt": "string",
"topicSetBy": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
}
}
],
"message": "string",
"success": true,
"timestamp": "string"
}

Get group info

Get group info by group id

Authorizations:

ApiKeyAuth

path Parameters

groupId

required

string

Group ID

Responses

Response samples

Content type

application/json

{"data": {"announceVersionID": "string",
"disappearingTimer": 0,
"groupCreated": "string",
"isAnnounce": true,
"isEphemeral": true,
"isLocked": true,
"jid": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"name": "string",
"nameSetAt": "string",
"nameSetBy": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"ownerJID": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
},
"participantVersionID": "string",
"participants": [{"isAdmin": true,
"isSuperAdmin": true,
"jid": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
}
}
],
"topic": "string",
"topicID": "string",
"topicSetAt": "string",
"topicSetBy": {"ad": true,
"agent": 0,
"device": 0,
"server": "string",
"user": "string"
}
},
"message": "string",
"success": true,
"timestamp": "string"
}

media

Upload media

Authorizations:

ApiKeyAuth

Request Body schema: multipart/form-data

Media

caption	string
filename	string
id	string
link	string
type required	string

Responses

Response samples

Content type

application/json

{"data": null,
"message": "string",
"success": true,
"timestamp": "string"
}

message

Send message to Chat

send message to Chat

Authorizations:

ApiKeyAuth

Request Body schema: application/json

Send message

	object (models.Media)
	object (models.Media)
	object (models.Media)
	object (models.Interactive)
preview_url	boolean Default: false
recipient_type	string Default: "individual" Enum: "individual" "group"
	object (models.Text)
to required	string
type required	string Default: "text" Enum: "text" "image" "video" "audio" "document" "interactive"
	object (models.Media)

Responses

Request samples

Payload

Content type

application/json

{"audio": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"document": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"image": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"interactive": {"action": {"button": "string",
"buttons": [{"reply": {"description": "string",
"id": "string",
"title": "string"
},
"type": "reply"
}
],
"sections": [{"rows": [{"description": "string",
"id": "string",
"title": "string"
}
],
"title": "string"
}
]
},
"body": {"text": "string"
},
"footer": {"text": "string"
},
"header": {"audio": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"document": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"image": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"text": {"text": "string"
},
"type": "text",
"video": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
}
},
"type": "list"
},
"preview_url": false,
"recipient_type": "individual",
"text": {"body": "string"
},
"to": "string",
"type": "text",
"video": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
}
}

Response samples

Content type

application/json

{"data": {"audio": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"document": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"image": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"interactive": {"action": {"button": "string",
"buttons": [{"reply": {"description": "string",
"id": "string",
"title": "string"
},
"type": "reply"
}
],
"sections": [{"rows": [{"description": "string",
"id": "string",
"title": "string"
}
],
"title": "string"
}
]
},
"body": {"text": "string"
},
"footer": {"text": "string"
},
"header": {"audio": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"document": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"image": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
},
"text": {"text": "string"
},
"type": "text",
"video": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
}
},
"type": "list"
},
"preview_url": false,
"recipient_type": "individual",
"text": {"body": "string"
},
"to": "string",
"type": "text",
"video": {"caption": "string",
"filename": "string",
"id": "string",
"link": "string",
"type": "string"
}
},
"message": "string",
"success": true,
"timestamp": "string"
}