Skip to main content

Endpoint

GET /api/v1/instances/{id}/state

Parameters path

NomTypeRequiredDescription
idUUIDyesID de l’instance

Request example

curl https://srv.msgflash.com/api/v1/instances/INSTANCE_ID/state \
  -H "x-api-key: msgf_live_your_api_key_here"

Success response 200

{
  "data": {
    "instanceId": "inst_uuid",
    "status": "connected",
    "providerState": "open"
  }
}

Common errors

HTTPCodeWhen
404NOT_FOUNDInstance does not exist or is outside your account