Evolution API
| Schemes | evolution://, evolutions:// |
| Cargo feature | service-evolution |
| Service | https://github.com/EvolutionAPI/evolution-api |
| Body formats | markdown (first is the default) |
| Attachments | no |
| Title length | no title (merged into the body) |
| Body length | 32,768 characters |
| Body lines | unlimited |
| Request throttle | none |
| Vendor URLs accepted | no |
URL formats
{schema}://{apikey}@{host}/{instance}/{targets}
{schema}://{apikey}@{host}:{port}/{instance}/{targets}
{schema} is one of evolution://, evolutions://.
URL tokens
| Token | Meaning | Type | Required | Default | Notes |
|---|---|---|---|---|---|
{apikey} | API Key | string | yes | secret | |
{host} | Hostname | string | yes | ||
{instance} | Instance Name | string | yes | ||
{port} | Port | int, 1 to 65535 | no | ||
{target_phone} | Target Phone No | string | no | prefix +; must match ^[0-9\s)(+-]+$ | |
{targets} | Targets | list | no | any of target_phone; separated by / |
Query parameters
| Parameter | Meaning | Type | Default | Notes |
|---|---|---|---|---|
to | Targets | list | sets {targets} |
The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.
Examples
Accepted URLs (tokens are fake):
evolution://myapikey@hostname/myinstance/5511999999999
evolutions://myapikey@hostname/myinstance/5511999999999
evolution://myapikey@hostname/myinstance/5511999999999/5521888888888
evolution://myapikey@hostname/myinstance/5511999999999/bad/+1 (555) 123-4567
evolution://myapikey@hostname/myinstance?to=5511999999999,5521888888888
Rejected URLs:
evolution://
evolution://:@/
evolution://hostname/myinstance/5511999999999
evolution://myapikey@hostname/5511999999999
Send one from the command line:
mercurio -t 'Backup' -b 'Finished in 42s' 'evolution://myapikey@hostname/myinstance/5511999999999'
Notes
Evolution API (evolution://, evolutions://): WhatsApp messages through an Evolution API server.