Update Message Delivery Status messageservice.message.status.update

We are still updating this page

Some data may be missing here — we will complete it shortly.

Scope: messageservice

Who can execute the method: administrator

This method allows you to set the delivery status of a specified message sent via the messaging provider.

Parameter

Description

CODE*

Provider code.

MESSAGE_ID*

Message identifier.

STATUS

Message status. Required. Allowed statuses:

  • delivered - delivered
  • undelivered - not delivered
  • failed - delivery error

Required parameters are marked with *

Example

try
        {
        	const response = await $b24.callMethod(
        		'messageservice.message.status.update',
        		{
        			CODE: 'provider1',
        			message_id: 1,
        			status: 'delivered'
        		}
        	);
        	
        	const result = response.getData().result;
        	alert("Success: " + result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'messageservice.message.status.update',
                    [
                        'CODE'      => 'provider1',
                        'message_id' => 1,
                        'status'     => 'delivered',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . $result->data();
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating message status: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'messageservice.message.status.update',
            {
                CODE: 'provider1',
                message_id: 1,
                status: 'delivered'
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data());
            }
        );
        

How to Use Examples in Documentation