Skip to main content
Use $vzaps->queues() to monitor pending messages and operations for an instance. Common fields on all calls:
FieldTypeRequiredDescription
instanceIdstringYesInstance ID.
instanceTokenstringYesInstance token.

​
queues()->listMessages($request)

Lists the pending message queue. 
$messages = $vzaps->queues()->listMessages([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
]);

print_r($messages);
Return: envelope { code, success, data } with count and messages[] (id, type, status, etc.).

​
queues()->removeMessage($request)

Removes one specific message from the queue. 
$vzaps->queues()->removeMessage([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'messageId' => 'queue-message-id',
]);
Return: envelope { code, success, data } with message_id, count, details.

​
queues()->purgeMessages($request)

Removes every pending item from the message queue. Use only when you are sure.
$vzaps->queues()->purgeMessages([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
]);
Return: envelope { code, success, data } with removed count.

​
queues()->listOperations($request)

Lists the pending operation queue. 
$operations = $vzaps->queues()->listOperations([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
]);

print_r($operations);
Return: envelope { code, success, data } with pending operations queue.

​
queues()->removeOperation($request)

Removes one specific operation from the queue. 
$vzaps->queues()->removeOperation([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
    'messageId' => 'queue-operation-id',
]);
Return: envelope { code, success, data } with message_id, count, details.

​
queues()->purgeOperations($request)

Removes every pending item from the operation queue. Use only when you are sure.
$vzaps->queues()->purgeOperations([
    'instanceId' => 'VZ...',
    'instanceToken' => 'instance-token',
]);
Return: envelope { code, success, data } with removed count.