Evolution GO Compatibility Layer — API Reference

The Pilot Status Evolution GO API Layer gives you a drop-in replacement for your Evolution GO server. You keep every request body, header, and path exactly as they are today — the only change you make is swapping out your base URL. Pilot Status translates your Evolution GO-compatible requests into its native API and returns responses in the format your code already handles.

Base URL

Point your HTTP client or environment variable at the following base URL to start using the Evolution GO layer:

https://pilotstatus.com.br/api/layer/evolution-go/

All paths you currently use with your Evolution GO server append directly to this URL. No other changes are required.

Authentication

Pass your Pilot Status API key using the same header your existing Evolution GO code already sends. If your code uses the apikey header, continue using it:

apikey: YOUR_API_KEY

If your code uses a Bearer token header instead, that format is also accepted:

Authorization: Bearer YOUR_API_KEY

Use whichever format matches your existing implementation — you do not need to change your authentication code.

Supported operations

Every request is a call to <METHOD> https://pilotstatus.com.br/api/layer/evolution-go<PATH>. The instance is resolved from your API key, so Evolution GO paths that normally carry an instance segment do not need one here. Send operations are automatically load-balanced across your number’s connected instances.

Any path not listed below returns 404. Global or admin-only paths return 403 — they are never exposed through the layer (see Blocked paths).

Instance (session)

Method	Path
POST	`/instance/connect`
GET	`/instance/status`
GET	`/instance/qr`
POST	`/instance/pair`
POST	`/instance/disconnect`
POST	`/instance/reconnect`
DELETE	`/instance/logout`
GET	`/instance/{id}/advanced-settings`
PUT	`/instance/{id}/advanced-settings`

Send (load-balanced)

These endpoints send messages through the Evolution GO layer; the number is selected by the API key, so the path has no instance segment and number in the body is the recipient.

POST /send/text — Send text message

Sends a plain text message; when linkPreview is true the server enriches the first URL in text with an OpenGraph preview card.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID (e.g. `5511999999999` or `5511999999999@s.whatsapp.net`, group `...@g.us`).
`text`	string	Yes	Message body.
`linkPreview`	boolean	No	Fetch OpenGraph metadata for the first URL in `text` and attach a preview.
`id`	string	No	Client-supplied message id for tracking/idempotency.
`delay`	integer	No	Milliseconds to wait (as “typing”) before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`); set `false` to send the value as-is.
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "text": "Hello from Pilot Status! https://pilotstatus.com.br",
  "linkPreview": true,
  "delay": 1200,
  "quoted": {
    "messageId": "3EB0C767D097B7C7A0A1",
    "participant": "5511988888888@s.whatsapp.net"
  }
}

POST /send/link — Send link preview

Sends a text message with a rich link card; the server auto-fetches title, description and imgUrl from the URL found in text, so those fields are optional and any value you pass may be overridden.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`text`	string	Yes	Message body containing the URL to preview.
`title`	string	No	Preview title (auto-filled from OpenGraph when omitted).
`description`	string	No	Preview description (auto-filled when omitted).
`url`	string	No	Target URL of the preview.
`imgUrl`	string	No	Thumbnail image URL (auto-filled when omitted).
`id`	string	No	Client-supplied message id.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "text": "Check this out: https://pilotstatus.com.br",
  "title": "Pilot Status",
  "description": "WhatsApp API platform",
  "url": "https://pilotstatus.com.br",
  "imgUrl": "https://pilotstatus.com.br/og.png"
}

POST /send/media — Send media message

Sends an image, video, audio or document by URL (JSON body) — or as a multipart/form-data upload with a file field; type selects the media kind.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`url`	string	Yes	Media URL (JSON mode). In `multipart/form-data`, send the binary in a `file` field instead.
`type`	string	Yes	Media kind: `image`, `video`, `audio`, `document` (also `ptv`).
`caption`	string	No	Caption text (image/video/document).
`filename`	string	No	File name shown for documents.
`id`	string	No	Client-supplied message id.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "type": "image",
  "url": "https://example.com/photo.jpg",
  "caption": "Look at this"
}

POST /send/poll — Send poll

Sends a poll with a question and a list of options; requires at least two options.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`question`	string	Yes	Poll question.
`options`	string[]	Yes	Answer options (minimum 2).
`maxAnswer`	integer	No	Maximum options a voter may select (`1` = single choice).
`id`	string	No	Client-supplied message id.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "question": "Best day for the meeting?",
  "options": ["Monday", "Tuesday", "Wednesday"],
  "maxAnswer": 1
}

POST /send/sticker — Send sticker

Sends a sticker from an image URL; the server downloads it and converts it to WebP before sending.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`sticker`	string	Yes	`http(s)` image URL to convert into a sticker.
`id`	string	No	Client-supplied message id.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "sticker": "https://example.com/sticker.png"
}

POST /send/location — Send location

Sends a geographic location pin with a name and address label.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`name`	string	Yes	Location name/title.
`address`	string	Yes	Street address label.
`latitude`	number	Yes	Latitude in decimal degrees.
`longitude`	number	Yes	Longitude in decimal degrees.
`id`	string	No	Client-supplied message id.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "name": "Pilot Status HQ",
  "address": "Av. Paulista, 1000, Sao Paulo",
  "latitude": -23.561414,
  "longitude": -46.655881
}

POST /send/contact — Send contact card

Sends a vCard contact card; fullName and phone are required inside vcard.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`vcard`	object	Yes	Contact card object (see nested fields).
`vcard.fullName`	string	Yes	Contact’s full name.
`vcard.phone`	string	Yes	Contact’s phone number.
`vcard.organization`	string	No	Contact’s organization.
`id`	string	No	Client-supplied message id.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "vcard": {
    "fullName": "Joao Silva",
    "organization": "Acme Ltda",
    "phone": "5511988888888"
  }
}

POST /send/button — Send interactive buttons

Sends an interactive message with tappable buttons; each button’s behavior is set per-item via type (reply, url, call, copy, etc.).

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`title`	string	Yes	Header/title text.
`description`	string	Yes	Body text.
`footer`	string	No	Footer text.
`imageUrl`	string	No	Header image URL.
`buttons`	array	Yes	Button objects: `{ type, displayText, id, url, phoneNumber, copyCode, currency, name, keyType, key }`.
`id`	string	No	Client-supplied message id.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "title": "Order #123",
  "description": "Your order is ready.",
  "footer": "Pilot Status",
  "buttons": [
    { "type": "reply", "displayText": "Confirm", "id": "confirm_1" },
    { "type": "url", "displayText": "Track", "url": "https://track.example.com/123" }
  ]
}

POST /send/list — Send list menu

Sends a menu message where the recipient taps buttonText to open sections of selectable rows.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`title`	string	Yes	Header/title text.
`description`	string	Yes	Body text.
`buttonText`	string	Yes	Label of the button that opens the list.
`footerText`	string	Yes	Footer text.
`sections`	array	Yes	Section objects: `{ title, rows: [{ title, description, rowId }] }`.
`id`	string	No	Client-supplied message id.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "title": "Menu",
  "description": "Choose an option",
  "buttonText": "Open menu",
  "footerText": "Pilot Status",
  "sections": [
    {
      "title": "Drinks",
      "rows": [
        { "title": "Coffee", "description": "Hot brewed", "rowId": "drink_coffee" },
        { "title": "Tea", "description": "Green tea", "rowId": "drink_tea" }
      ]
    }
  ]
}

POST /send/carousel — Send carousel cards

Sends a horizontally scrollable carousel; each card has its own image, text and buttons.

Field	Type	Required	Description
`number`	string	Yes	Recipient MSISDN or JID.
`title`	string	Yes	Header/title text.
`description`	string	Yes	Body text.
`footerText`	string	Yes	Footer text.
`cards`	array	Yes	Card objects: `{ text, thumbnailUrl, footerText, buttons: [Button] }`.
`delay`	integer	No	Milliseconds to wait before sending.
`mentionedJid`	string	No	JID(s) to mention.
`mentionAll`	boolean	No	Mention every participant (groups).
`formatJid`	boolean	No	Auto-format `number` into a JID (default `true`).
`quoted`	object	No	Reply-to reference: `{ "messageId", "participant" }`.

{
  "number": "5511999999999",
  "title": "Featured products",
  "description": "Swipe to browse",
  "footerText": "Pilot Status",
  "cards": [
    {
      "text": "Product A",
      "thumbnailUrl": "https://example.com/a.jpg",
      "footerText": "In stock",
      "buttons": [
        { "type": "url", "displayText": "Buy", "url": "https://shop.example.com/a" }
      ]
    }
  ]
}

User / Contacts

The apikey selects the number, so no instance segment appears in the path or body.

POST /user/info — Get user info

Fetches WhatsApp account details (JID, name, business name) for one or more phone numbers.

Field	Type	Required	Description
`number`	string[]	Yes	Phone numbers in international format to look up.
`formatJid`	boolean	No	When true, returns each result keyed by formatted JID.

{
  "number": ["5511999999999"],
  "formatJid": true
}

POST /user/check — Check on WhatsApp

Checks whether the given phone numbers are registered on WhatsApp.

Field	Type	Required	Description
`number`	string[]	Yes	Phone numbers in international format to verify.
`formatJid`	boolean	No	When true, returns each result keyed by formatted JID.

{
  "number": ["5511999999999", "5511888888888"],
  "formatJid": false
}

POST /user/avatar — Get user avatar

Returns the profile picture URL for a phone number.

Field	Type	Required	Description
`number`	string	Yes	Phone number in international format.
`preview`	boolean	No	When true, returns the low-resolution preview image instead of the full-size picture.

{
  "number": "5511999999999",
  "preview": false
}

GET /user/contacts — List contacts

Returns all contacts stored for the connected number.No request body.

GET /user/privacy — Get privacy settings

Returns the connected number’s current privacy settings.No request body.

POST /user/privacy — Set privacy settings

Updates the connected number’s privacy settings. Each field takes a privacy scope such as all, contacts, contact_blacklist, known, match_last_seen, or none.

Field	Type	Required	Description
`groupAdd`	string	Yes	Who can add you to groups (`all`, `contacts`, `contact_blacklist`, `none`).
`lastSeen`	string	Yes	Who can see your last seen (`all`, `contacts`, `contact_blacklist`, `none`).
`status`	string	Yes	Who can see your status (`all`, `contacts`, `contact_blacklist`, `none`).
`profile`	string	Yes	Who can see your profile photo (`all`, `contacts`, `contact_blacklist`, `none`).
`readReceipts`	string	Yes	Read receipts setting (`all`, `none`).
`callAdd`	string	Yes	Who can call you (`all`, `known`).
`online`	string	Yes	Who can see when you are online (`all`, `match_last_seen`).

{
  "groupAdd": "contacts",
  "lastSeen": "contacts",
  "status": "contacts",
  "profile": "all",
  "readReceipts": "all",
  "callAdd": "known",
  "online": "match_last_seen"
}

POST /user/block — Block a contact

Blocks the given contact for the connected number.

Field	Type	Required	Description
`number`	string	Yes	Phone number in international format to block.

{
  "number": "5511999999999"
}

POST /user/unblock — Unblock a contact

Removes the given contact from the block list.

Field	Type	Required	Description
`number`	string	Yes	Phone number in international format to unblock.

{
  "number": "5511999999999"
}

GET /user/blocklist — List blocked contacts

Returns the block list for the connected number.No request body.

POST /user/profilePicture — Set profile picture

Sets the connected number’s profile picture.

Field	Type	Required	Description
`image`	string	Yes	Image as a URL or base64-encoded data.

{
  "image": "https://media.pilotstatus.com.br/avatar.jpg"
}

POST /user/profileName — Set profile name

Updates the connected number’s display name.

Field	Type	Required	Description
`name`	string	Yes	New profile display name.

{
  "name": "Pilot Status Support"
}

POST /user/profileStatus — Set profile status

Updates the connected number’s status (about) text.

Field	Type	Required	Description
`status`	string	Yes	New profile status text.

{
  "status": "Available"
}

Message

Message-level actions on the connected number — the apikey selects the number, so never include an instance in the path or body.

POST /message/react — React to message

Sends an emoji reaction to an existing message; supports fromMe and (for group messages) the participant author.

Field	Type	Required	Description
`number`	string	Yes	Recipient chat, as a phone in E.164 digits or a JID
`reaction`	string	Yes	Emoji to react with (send an empty string to remove the reaction)
`id`	string	Yes	ID of the message to react to
`fromMe`	boolean	No	Whether the target message was sent by you
`participant`	string	No	Author JID of the message (needed for group messages)

{
  "number": "5511999999999",
  "reaction": "👍",
  "id": "3EB0A1B2C3D4E5F6A7B8",
  "fromMe": false,
  "participant": "5511988888888@s.whatsapp.net"
}

POST /message/presence — Send chat presence

Broadcasts a typing or recording presence indicator to a chat.

Field	Type	Required	Description
`number`	string	Yes	Target chat, as a phone in E.164 digits or a JID
`state`	string	Yes	Presence state: `composing` (typing) or `paused`
`isAudio`	boolean	No	When true, shows “recording audio” instead of typing

{
  "number": "5511999999999",
  "state": "composing",
  "isAudio": false
}

POST /message/markread — Mark messages read

Marks one or more messages in a chat as read.

Field	Type	Required	Description
`number`	string	Yes	Chat whose messages are being read, as a phone in E.164 digits or a JID
`id`	string[]	Yes	Array of message IDs to mark as read

{
  "number": "5511999999999",
  "id": ["3EB0A1B2C3D4E5F6A7B8", "3EB0F9E8D7C6B5A43210"]
}

POST /message/downloadmedia — Download media

Downloads and decrypts the media attached to a received message, returning it as a base64 data URL.

Field	Type	Required	Description
`message`	object	Yes	Full message payload containing the media node to download — one of `imageMessage`, `audioMessage`, `videoMessage`, `documentMessage`, or `stickerMessage` — with its `url`, `directPath`, `mediaKey`, `fileEncSHA256`, `fileSHA256`, `mimetype`, and `fileLength`

{
  "message": {
    "imageMessage": {
      "url": "https://mmg.whatsapp.net/d/f/AbCdEf123456.enc",
      "directPath": "/v/t62.7118-24/12345_67890.enc",
      "mediaKey": "sPqT2bXyZ0aBcDeFgHiJkLmNoPqRsTuVwXyZ012345=",
      "mimetype": "image/jpeg",
      "fileEncSHA256": "9dJkLmNoPqRsTuVwXyZ0123456789AbCdEfGhIjKlMno=",
      "fileSHA256": "Q1w2E3r4T5y6U7i8O9p0AsDfGhJkLzXcVbNmQwErTyU=",
      "fileLength": 24576
    }
  }
}

POST /message/status — Get message status

Looks up the stored delivery status of a message by its ID.

Field	Type	Required	Description
`id`	string	Yes	ID of the message to look up

{
  "id": "3EB0A1B2C3D4E5F6A7B8"
}

POST /message/delete — Delete for everyone

Revokes a message for everyone in the chat.

Field	Type	Required	Description
`chat`	string	Yes	Chat where the message lives, as a JID or phone in E.164 digits
`messageId`	string	Yes	ID of the message to revoke

{
  "chat": "5511999999999@s.whatsapp.net",
  "messageId": "3EB0A1B2C3D4E5F6A7B8"
}

POST /message/edit — Edit a message

Replaces the text content of a previously sent message.

Field	Type	Required	Description
`chat`	string	Yes	Chat where the message lives, as a JID or phone in E.164 digits
`message`	string	Yes	New text content for the message
`messageId`	string	Yes	ID of the message to edit

{
  "chat": "5511999999999@s.whatsapp.net",
  "message": "Corrected text",
  "messageId": "3EB0A1B2C3D4E5F6A7B8"
}

Chat

Manage chat state (pin, archive, mute) and request message history for the number selected by your API key.

POST /chat/pin — Pin a chat

Pins a chat to the top of the list.

Field	Type	Required	Description
`chat`	string	Yes	JID of the chat to pin (individual `...@s.whatsapp.net` or group `...@g.us`).

{
  "chat": "5511999999999@s.whatsapp.net"
}

POST /chat/unpin — Unpin a chat

Removes a chat from the pinned list.

Field	Type	Required	Description
`chat`	string	Yes	JID of the chat to unpin.

{
  "chat": "5511999999999@s.whatsapp.net"
}

POST /chat/archive — Archive a chat

Archives a chat, hiding it from the main list.

Field	Type	Required	Description
`chat`	string	Yes	JID of the chat to archive.

{
  "chat": "5511999999999@s.whatsapp.net"
}

POST /chat/unarchive — Unarchive a chat

Restores an archived chat back to the main list.

Field	Type	Required	Description
`chat`	string	Yes	JID of the chat to unarchive.

{
  "chat": "5511999999999@s.whatsapp.net"
}

POST /chat/mute — Mute a chat

Mutes notifications for a chat.

Field	Type	Required	Description
`chat`	string	Yes	JID of the chat to mute.

{
  "chat": "120363000000000000@g.us"
}

POST /chat/unmute — Unmute a chat

Re-enables notifications for a muted chat.

Field	Type	Required	Description
`chat`	string	Yes	JID of the chat to unmute.

{
  "chat": "120363000000000000@g.us"
}

POST /chat/history-sync — Request history sync

Requests older message history from before a reference message. The messageInfo object identifies the anchor message (its Chat JID, message ID, direction flags, and Timestamp); fields are unmarshalled from the whatsmeow MessageInfo type, so keys are PascalCase and Chat is a JID string.

Field	Type	Required	Description
`messageInfo`	object	Yes	Reference message to sync history before. Contains `Chat` (JID string), `ID` (message id), `IsFromMe` (boolean), `IsGroup` (boolean), and `Timestamp` (RFC 3339).
`count`	integer	No	Number of messages to fetch before the reference message.

{
  "messageInfo": {
    "Chat": "5511999999999@s.whatsapp.net",
    "ID": "3EB0C767D82B0A1B2C3D",
    "IsFromMe": false,
    "IsGroup": false,
    "Timestamp": "2026-07-09T12:00:00Z"
  },
  "count": 50
}

Group

Manage WhatsApp groups for the connected number: list, inspect, create, update, and join or leave. The apikey selects the number, so no instance segment is used.

GET /group/list — List joined groups

Returns every group the connected number has joined.No request body.

POST /group/info — Get group info

Fetches metadata (name, participants, owner) for a single group.

Field	Type	Required	Description
`groupJid`	string	Yes	Group JID (`<id>@g.us`).

{
  "groupJid": "120363012345678901@g.us"
}

POST /group/invitelink — Get invite link

Returns the group’s invite link, optionally revoking the old one first.

Field	Type	Required	Description
`groupJid`	string	Yes	Group JID (`<id>@g.us`).
`reset`	boolean	No	When `true`, revokes the current link and generates a new one.

{
  "groupJid": "120363012345678901@g.us",
  "reset": false
}

POST /group/photo — Set group photo

Sets the group’s profile picture from a public URL or a base64 data URI.

Field	Type	Required	Description
`groupJid`	string	Yes	Group JID (`<id>@g.us`).
`image`	string	Yes	Image as an `http(s)` URL or a `data:image/jpeg;base64,` / `data:image/png;base64,` data URI.

{
  "groupJid": "120363012345678901@g.us",
  "image": "https://example.com/group-photo.jpg"
}

POST /group/name — Set group name

Updates the group’s subject (name).

Field	Type	Required	Description
`groupJid`	string	Yes	Group JID (`<id>@g.us`).
`name`	string	Yes	New group name.

{
  "groupJid": "120363012345678901@g.us",
  "name": "Sales Team"
}

POST /group/description — Set group description

Updates the group’s description (topic).

Field	Type	Required	Description
`groupJid`	string	Yes	Group JID (`<id>@g.us`).
`description`	string	Yes	New group description.

{
  "groupJid": "120363012345678901@g.us",
  "description": "Team coordination and announcements"
}

POST /group/create — Create group

Creates a new group with the given name and initial participants.

Field	Type	Required	Description
`groupName`	string	Yes	Name of the new group.
`participants`	string[]	Yes	Phone numbers or JIDs to add (at least one).

{
  "groupName": "Sales Team",
  "participants": [
    "5511999999999",
    "5511888888888"
  ]
}

POST /group/participant — Update participants

Adds, removes, promotes, or demotes participants in a group.

Field	Type	Required	Description
`groupJid`	string	Yes	Group JID (`<id>@g.us`).
`participants`	string[]	Yes	Phone numbers or JIDs to act on (at least one).
`action`	string	Yes	One of `add`, `remove`, `promote`, `demote`.

{
  "groupJid": "120363012345678901@g.us",
  "participants": [
    "5511999999999"
  ],
  "action": "add"
}

GET /group/myall — List owned groups

Returns only the groups the connected number owns (is admin/owner of).No request body.

POST /group/join — Join via invite

Joins a group using an invite code (the token from an invite link).

Field	Type	Required	Description
`code`	string	Yes	Invite code (the segment after `chat.whatsapp.com/`).

{
  "code": "AbCdEfGhIjKlMnOpQrStUv"
}

POST /group/leave — Leave group

Leaves the specified group.

Field	Type	Required	Description
`groupJid`	string	Yes	Group JID (`<id>@g.us`).

{
  "groupJid": "120363012345678901@g.us"
}

Call (voice)

Place, answer, reject, hang up and stream audio on WhatsApp voice calls. The apikey selects the number, so no instance goes in the path or body.

POST /call/start — Start outbound call

Places an outbound WhatsApp voice call to the given number and returns the created call session.

Field	Type	Required	Description
`number`	string	Yes	Recipient phone in DDI+DDD+number format (e.g. `5511999999999`) or a full JID.

{
  "number": "5511999999999"
}

GET /call/list — List active calls

Returns all currently tracked call sessions for the number.No request body.

POST /call/get — Get call by id

Returns the current state of a single tracked call session.

Field	Type	Required	Description
`callId`	string	No	Identifier of the call to fetch. An empty body is accepted (returns the latest tracked call).

{
  "callId": "3EB0C767D26A8B4E7F1A"
}

POST /call/answer — Answer incoming call

Answers a ringing incoming call; omit callId to answer the latest incoming call.

Field	Type	Required	Description
`callId`	string	No	Identifier of the incoming call to answer. When omitted, the most recent incoming call is answered.

{
  "callId": "3EB0C767D26A8B4E7F1A"
}

POST /call/reject — Reject call

Rejects a call; if the call is no longer tracked, it falls back to rejecting via callCreator.

Field	Type	Required	Description
`callId`	string	Yes	Identifier of the call to reject.
`callCreator`	string	No	JID of the caller, used as a fallback when the call is not tracked (e.g. `5511999999999@s.whatsapp.net`).

{
  "callId": "3EB0C767D26A8B4E7F1A",
  "callCreator": "5511999999999@s.whatsapp.net"
}

POST /call/reject/by-id — Reject tracked call

Rejects a currently tracked call by its identifier.

Field	Type	Required	Description
`callId`	string	Yes	Identifier of the tracked call to reject.

{
  "callId": "3EB0C767D26A8B4E7F1A"
}

POST /call/reject/latest — Reject latest offer

Rejects the most recently offered incoming call for the number.No request body.

POST /call/hangup — Hang up call

Ends an active call by its identifier.

Field	Type	Required	Description
`callId`	string	Yes	Identifier of the active call to hang up.

{
  "callId": "3EB0C767D26A8B4E7F1A"
}

POST /call/media/play — Play audio to call

Streams an audio file into an active call. Accepts this JSON body (server-side filePath) or a multipart/form-data upload with fields callId, audio (or file) and hangupAfterPlay.

Field	Type	Required	Description
`callId`	string	Yes	Identifier of the active call to play into.
`filePath`	string	Yes	Server-side path to the audio file (`.mp3`, `.wav` or `.opus`).
`hangupAfterPlay`	boolean	No	When `true`, ends the call automatically once playback finishes. Defaults to `false`.

{
  "callId": "3EB0C767D26A8B4E7F1A",
  "filePath": "/audios/greeting.mp3",
  "hangupAfterPlay": true
}

POST /call/media/realtime/session — Create realtime session

Creates a short-lived token and WebSocket URL for streaming realtime PCM audio to/from an active call.

Field	Type	Required	Description
`callId`	string	Yes	Identifier of the active call to attach media to.
`mode`	string	No	`talk` (send and receive audio, default) or `listen` (receive only).

{
  "callId": "3EB0C767D26A8B4E7F1A",
  "mode": "talk"
}

Community

Manage WhatsApp communities and their linked groups. The API key selects the number, so no instance is included in the path or body.

POST /community/create — Create community

Creates a new community with the given name.

Field	Type	Required	Description
`communityName`	string	Yes	Display name of the community to create.

{
  "communityName": "Pilot Status Community"
}

POST /community/add — Add groups

Links one or more existing groups to a community.

Field	Type	Required	Description
`communityJid`	string	Yes	JID of the target community.
`groupJid`	string[]	Yes	Array of group JIDs to add to the community.

{
  "communityJid": "120363000000000000@g.us",
  "groupJid": [
    "120363111111111111@g.us",
    "120363222222222222@g.us"
  ]
}

POST /community/remove — Remove groups

Unlinks one or more groups from a community.

Field	Type	Required	Description
`communityJid`	string	Yes	JID of the target community.
`groupJid`	string[]	Yes	Array of group JIDs to remove from the community.

{
  "communityJid": "120363000000000000@g.us",
  "groupJid": [
    "120363111111111111@g.us"
  ]
}

Label

Manage WhatsApp labels: attach or detach them from chats and messages, edit a label, and list all labels. The apikey selects the number, so no instance is included in the path or body.

POST /label/chat — Add label to chat

Attaches an existing label to a chat.

Field	Type	Required	Description
`jid`	string	Yes	Chat JID to label.
`labelId`	string	Yes	ID of the label to attach.

{
  "jid": "5511999999999@s.whatsapp.net",
  "labelId": "1"
}

POST /label/message — Add label to message

Attaches an existing label to a specific message in a chat.

Field	Type	Required	Description
`jid`	string	Yes	Chat JID that contains the message.
`labelId`	string	Yes	ID of the label to attach.
`messageId`	string	Yes	ID of the target message.

{
  "jid": "5511999999999@s.whatsapp.net",
  "labelId": "1",
  "messageId": "3EB0C767D26A8A4E8F1B"
}

POST /label/edit — Edit label

Creates or updates a label’s name, color, or deleted state.

Field	Type	Required	Description
`labelId`	string	Yes	ID of the label to edit.
`name`	string	Yes	Display name of the label.
`color`	integer	No	Color index for the label.
`deleted`	boolean	No	Marks the label as deleted when true.

{
  "labelId": "1",
  "name": "Priority",
  "color": 3,
  "deleted": false
}

GET /label/list — List all labels

Returns every label defined on the connected number.No request body.

POST /unlabel/chat — Remove label from chat

Detaches a label from a chat.

Field	Type	Required	Description
`jid`	string	Yes	Chat JID to remove the label from.
`labelId`	string	Yes	ID of the label to detach.

{
  "jid": "5511999999999@s.whatsapp.net",
  "labelId": "1"
}

POST /unlabel/message — Remove label from message

Detaches a label from a specific message in a chat.

Field	Type	Required	Description
`jid`	string	Yes	Chat JID that contains the message.
`labelId`	string	Yes	ID of the label to detach.
`messageId`	string	Yes	ID of the target message.

{
  "jid": "5511999999999@s.whatsapp.net",
  "labelId": "1",
  "messageId": "3EB0C767D26A8A4E8F1B"
}

Manage WhatsApp newsletters (channels) — create, list, inspect, resolve invites, subscribe, and fetch messages. The apikey selects the number, so no instance segment appears in the path.

Creates a new newsletter (channel) with a name and optional description.

Field	Type	Required	Description
`name`	string	Yes	Newsletter (channel) display name.
`description`	string	No	Newsletter description shown to subscribers.

{
  "name": "Pilot Status Updates",
  "description": "Official channel for product news and status."
}

Resolves newsletter metadata from an invite key (the code portion of a channel invite link).

Field	Type	Required	Description
`key`	string	Yes	Invite key from the channel link (e.g. the part after `whatsapp.com/channel/`).

{
  "key": "0029VaAbCdEfGhIjKlMnOpQr"
}

Fetches messages from a newsletter, with optional count and before-id pagination.

Field	Type	Required	Description
`jid`	string	Yes	Newsletter JID (ends in `@newsletter`).
`count`	integer	No	Maximum number of messages to return.
`before_id`	integer	No	Return messages older than this message id (pagination cursor).

{
  "jid": "120363012345678901@newsletter",
  "count": 50,
  "before_id": 100
}

Blocked (admin/global)

These global and admin-only Evolution GO paths are not exposed through the layer and return 403: GET /server/ok · /swagger/* · POST /instance/create · GET /instance/all · GET /instance/info/{id} · DELETE /instance/delete/{id} · POST /instance/proxy/{id} · DELETE /instance/proxy/{id} · POST /instance/forcereconnect/{id} · GET /instance/logs/{id}

URLs in the request must be public

Some operations make the provider download or call a URL you send. Since 2026-09-28, Pilot Status checks each of those URLs before forwarding the request. If one points to an internal or private network address — localhost, a loopback or private IP, a host name without a dot, or a name that resolves to one of those — the request is refused with 400 and nothing is forwarded:

{
  "status": 400,
  "error": "Bad Request",
  "message": "Refused: a URL in the request points to an internal or private network address, which we never fetch. Use a public address."
}

The URLs checked:

Media sent by URL: /send/media (url), /send/sticker (sticker), /send/button (imageUrl) and /send/carousel (each card’s thumbnailUrl).
Links: /send/link (imgUrl, and the link in text), and the link in /send/text’s text when you send linkPreview: true.
Pictures: /user/profilePicture and /group/photo (image).
Webhook: /instance/connect (webhookUrl).

Only http(s) values are checked: base64 and data: media pass untouched, and a multipart upload is forwarded as is. A host name that does not resolve is not refused here.

Events

The layer forwards events to your configured webhook in Evolution GO’s own native (PascalCase) format, so your existing event handlers keep working unchanged: Message · SendMessage · Receipt · Presence · ChatPresence · Archive · CallOffer · CallAccept · CallTerminate · Connected · PairSuccess · TemporaryBan · LoggedOut · ConnectFailure · Disconnected · LabelEdit · LabelAssociationChat · LabelAssociationMessage · Contact · PushName · GroupInfo · JoinedGroup · NewsletterJoin · NewsletterLeave · QRCode · QRSuccess The modern UPPER_SNAKE aliases are also accepted: MESSAGES_UPSERT · SEND_MESSAGE · CONNECTION_UPDATE · QRCODE_UPDATED · PRESENCE_UPDATE · CHATS_UPSERT · CHATS_UPDATE · CHATS_DELETE · GROUPS_UPSERT · GROUPS_UPDATE · GROUP_PARTICIPANTS_UPDATE · CALL · CONTACTS_UPSERT · CONTACTS_UPDATE · NEWSLETTER_UPDATE · LABEL_EDIT · LABEL_ASSOCIATION In addition, Pilot Status can deliver its own normalized events alongside the native ones:

Call lifecycle: call.ringing, call.connected, call.ended, call.missed
Number lifecycle: number.created, number.connected, number.disconnected, number.removed, number.restored

Example: send text via Evolution GO layer

The request below is a real Evolution GO layer call — a standard POST /send/text, with only the base URL changed to route through Pilot Status. There is no instance segment in the path: the apikey header selects the instance.

curl -X POST 'https://pilotstatus.com.br/api/layer/evolution-go/send/text' \
  -H 'apikey: YOUR_PILOT_STATUS_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "number": "5511999999999", "text": "Hello from Pilot Status! 👋" }'

The body fields are the same your Evolution GO code already sends to POST /send/text — number and text, plus optional fields like delay, quoted, and mentionedJid. The response format is identical to what your existing code consumes.

If any Evolution GO operation is not supported by the layer, use the native Pilot Status API instead. For specific compatibility questions, contact support on WhatsApp: +55 85 98438-7245.

Overview

Messaging

Templates

Numbers

Phone Lines

Conversations & Data

Webhooks

Voice Calls

API Layer

Account & Billing

Branding & Embedding

Evolution GO Compatibility Layer — API Reference

Base URL

Authentication

Supported operations

Instance (session)

Send (load-balanced)

User / Contacts

Message

Chat

Group

Call (voice)

Community

Label

Blocked (admin/global)

URLs in the request must be public

Events

Example: send text via Evolution GO layer

​Base URL

​Authentication

​Supported operations

​Instance (session)

​Send (load-balanced)

​User / Contacts

​Message

​Chat

​Group

​Call (voice)

​Community

​Label

​Newsletter / Channels

​Blocked (admin/global)

​URLs in the request must be public

​Events

​Example: send text via Evolution GO layer

Base URL

Authentication

Supported operations

Instance (session)

Send (load-balanced)

User / Contacts

Message

Chat

Group

Call (voice)

Community

Label

Newsletter / Channels

Blocked (admin/global)

URLs in the request must be public

Events

Example: send text via Evolution GO layer