go-whatsapp-web-multidevice API documentation

16 days ago

Change #af624149

6.0.0

Breaking

Compare

41 structure changes including:

41 Modifications

Modified 41 Breaking

GET /app/devices

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /app/login

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /app/login-with-code

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /app/logout

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /app/reconnect

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /group/participant-requests

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /user/avatar

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /user/info

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /user/my/contacts

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /user/my/groups

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /user/my/newsletters

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

GET /user/my/privacy

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group/join-with-link

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group/leave

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group/participant-requests/approve

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group/participant-requests/reject

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group/participants

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group/participants/demote

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group/participants/promote

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /group/participants/remove

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /message/{message_id}/delete

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /message/{message_id}/reaction

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /message/{message_id}/read

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /message/{message_id}/revoke

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /message/{message_id}/star

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /message/{message_id}/unstar

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /message/{message_id}/update

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /newsletter/unfollow

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/audio

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/contact

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/file

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/image

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/link

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/location

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/message

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/poll

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/presence

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /send/video

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /user/avatar

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

POST /user/pushname

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string | null to string
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object | null to object
      Breaking

16 days ago

Change #df633a79

6.0.0

Breaking

Compare

41 structure changes including:

7 Additions

34 Modifications

Modified 34 Breaking

GET /app/devices

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /group/participants/demote

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /group/participants/promote

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /group/participants/remove

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /message/{message_id}/delete

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /message/{message_id}/reaction

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /message/{message_id}/read

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /message/{message_id}/revoke

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /message/{message_id}/update

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /newsletter/unfollow

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string to string | null
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/audio

Body
multipart/form-data content type Modified
- is_forwarded property Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/contact

Body
application/json content type Modified
- is_forwarded property Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/file

Body
multipart/form-data content type Modified
- is_forwarded property Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/image

Body
multipart/form-data content type Modified
- image_url, is_forwarded properties Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/link

Body
application/json content type Modified
- is_forwarded property Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/location

Body
application/json content type Modified
- is_forwarded property Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/message

Body
application/json content type Modified
- is_forwarded property Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/poll

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/presence

Body
application/json content type Modified
- presence property Removed
  - Removing a resource is always breaking unless it was deprecated before
    Breaking
- type, is_forwarded properties Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /send/video

Body
multipart/form-data content type Modified
- is_forwarded property Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /user/avatar

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string to string | null
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /app/login

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /app/login-with-code

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /app/logout

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string to string | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /app/reconnect

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string to string | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /user/avatar

Query
phone query parameter Modified
- Type went from integer to string
  Breaking
is_community query parameter Added
Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /user/info

Query
phone query parameter Modified
- Type went from integer to string
  Breaking
Response
200 response Modified
- application/json content type Modified
  - code, message, results properties Modified
    - Properties are now required
      Breaking
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /user/my/groups

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /user/my/newsletters

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

GET /user/my/privacy

Response
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /group

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /group/join-with-link

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string to string | null
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /group/leave

Response
200 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from string to string | null
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

POST /group/participants

Response
400 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
500 response Modified
- application/json content type Modified
  - results property Modified
    - Type went from object to object | null
Authentication
Basic auth authentication method Added

Added 7

POST /user/pushname

POST /message/{message_id}/unstar

POST /message/{message_id}/star

POST /group/participant-requests/reject

POST /group/participant-requests/approve

GET /user/my/contacts

GET /group/participant-requests

Jan 21, 2025

Change #80df9dbf

5.0.0

Compare

3 structure changes including:

3 Additions

Added 3

POST /message/{message_id}/read

POST /send/presence

POST /user/avatar

Oct 11, 2024

Change #73d5fdc6

4.3.0

Compare

4 structure changes including:

3 Additions

1 Modification

Modified 1

GET /user/my/groups

Response
200 response Added

Added 3

GET /app/login-with-code

GET /user/my/newsletters

POST /newsletter/unfollow

Jul 13, 2024

Change #779d80ba

4.1.0

Compare

3 structure changes including:

3 Additions

Added 3

POST /group/participants/demote

POST /group/participants/promote

POST /group/participants/remove

Jun 28, 2024

Change #4fc814c3

4.0.0

Breaking

Compare

9 structure changes including:

1 Addition

8 Modifications

Modified 8 Breaking

POST /group/join-with-link

Body
multipart/form-data content type Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
application/json content type Added

POST /group/leave

Body
multipart/form-data content type Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
application/json content type Added

POST /message/{message_id}/reaction

Body
multipart/form-data content type Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
application/json content type Added

POST /message/{message_id}/revoke

Body
multipart/form-data content type Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
application/json content type Added

POST /send/contact

Body
multipart/form-data content type Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
application/json content type Added

POST /send/link

Body
multipart/form-data content type Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
application/json content type Added

POST /send/location

Body
multipart/form-data content type Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
application/json content type Added

POST /send/message

Body
multipart/form-data content type Removed
- Removing a resource is always breaking unless it was deprecated before
  Breaking
application/json content type Added

Added 1

POST /message/{message_id}/delete

Apr 19, 2024

Change #d4049461

3.11.0

Compare

Do not miss any go-whatsapp-web-multidevice API changes, ever again

Changelog

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API structure has changed

API documentation has been created