Broker (Ametys 4.3.x - API)

All Known Implementing Classes:

EtoileDieseBroker, LoggerBroker
```
public interface Broker
```
The broker interface

Field Summary

Fields
Modifier and Type Field Description

static String ROLE
For avalon service manager

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getPhoneNumberFromStopRequest()`	When a stop request is arriving from broker, the implementation extract the phone number associated
`void`	`send(Set<String> phoneNumbersList, String message, String listId)`	Send the message from the sender to all the phones in the list

- Field Detail
  - ROLE
```
static final String ROLE
```
    For avalon service manager
- Method Detail
  - send
```
void send(Set<String> phoneNumbersList,
          String message,
          String listId)
   throws Exception
```
    Send the message from the sender to all the phones in the list
    
    Parameters:
    
    phoneNumbersList - the list of phone numbers
    
    message - the message to send
    
    listId - the jcr id of the list to send mail to
    
    Throws:
    
    Exception - If the message was not sent correctly
  - getPhoneNumberFromStopRequest
```
String getPhoneNumberFromStopRequest()
                              throws Exception
```
    When a stop request is arriving from broker, the implementation extract the phone number associated
    
    Returns:
    
    the phone number from the 'stop' sender at format +{countryCode}{number} (ex: +33612345678), it can be null if the phone number cannot be extracted from the stop request
    
    Throws:
    
    Exception - if the phone number was not provided within the stop request