Use vzaps.queues to monitor pending messages and operations for an instance.
Common fields on every call:
| Field | Type | Required | Description |
|---|
instanceId | string | Yes | Instance ID. |
instanceToken | string | Yes | Instance token. |
queues.listMessages(request)
Lists the pending message queue.
const messages = await vzaps.queues.listMessages({
instanceId: 'VZ...',
instanceToken: 'instance-token',
});
console.dir(messages, { depth: null });
{ code, success, data } with count and messages[] (id, type, status, etc.).
queues.removeMessage(request)
Removes one specific message from the queue.
await vzaps.queues.removeMessage({
instanceId: 'VZ...',
instanceToken: 'instance-token',
messageId: 'queue-message-id',
});
{ code, success, data } with messageId, count, details.
queues.purgeMessages(request)
Removes all pending items from the message queue. Use only when you are sure.
await vzaps.queues.purgeMessages({
instanceId: 'VZ...',
instanceToken: 'instance-token',
});
{ code, success, data } with removed count.
queues.listOperations(request)
Lists the pending operation queue.
const operations = await vzaps.queues.listOperations({
instanceId: 'VZ...',
instanceToken: 'instance-token',
});
console.dir(operations, { depth: null });
{ code, success, data } with pending operations queue.
queues.removeOperation(request)
Removes one specific operation from the queue.
await vzaps.queues.removeOperation({
instanceId: 'VZ...',
instanceToken: 'instance-token',
messageId: 'queue-operation-id',
});
{ code, success, data } with messageId, count, details.
queues.purgeOperations(request)
Removes all pending items from the operation queue. Use only when you are sure.
await vzaps.queues.purgeOperations({
instanceId: 'VZ...',
instanceToken: 'instance-token',
});
{ code, success, data } with removed count. 
