Get a list of SMS providers or message providers messageservice.sender.list

We are still updating this page

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

Scope: messageservice

Who can execute the method: administrator

The method returns a list of message providers registered by the current application (or the same incoming webhook).

Example

// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'messageservice.sender.list',
            {},
            (progress) => { console.log('Progress:', progress) }
          )
          const items = response.getData() || []
          for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('messageservice.sender.list', {}, 'ID')
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
          }
        } catch (error) {
          console.error('Request failed', error)
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('messageservice.sender.list', {}, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'messageservice.sender.list',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . implode(', ', $result->data());
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error calling messageservice.sender.list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'messageservice.sender.list',
            {},
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data().join(', '));
            }
        );

How to Use Examples in Documentation

Previous
Update Provider
Next
Delete Provider