github.com/e154/smart-home@v0.17.2-0.20240311175135-e530a6e5cd45/doc/content/en/docs/plugins/notify/messagebird.md (about)

     1  
     2  ---
     3  title: "Messagebird"
     4  linkTitle: "messagebird"
     5  date: 2021-10-20
     6  description: >
     7  
     8  ---
     9  
    10  To send SMS notifications through the MessageBird notification service provider, you'll need to register with MessageBird and have a positive balance.
    11  
    12  ### Configuration:
    13  - Access Key
    14  - Name
    15  
    16  ### Attributes:
    17  - Payment
    18  - Type
    19  - Amount
    20  
    21  ### JavaScript Properties:
    22  
    23  ----------------
    24  
    25  New Message:
    26  
    27  Creates a message object.
    28  
    29  ```coffeescript
    30  msg = notifr.newMessage();
    31  msg.entity_id = 'messagebird.name';
    32  msg.attributes = {
    33    'phone': '+79990000001',
    34    'body': 'some text'
    35  };
    36  ```
    37  
    38  | Value | Description |
    39  |-------|-------------|
    40  | newMessage() | Method |
    41  | msg | Type: Object (Message) |
    42  
    43  ----------------
    44  
    45  ### Code Example:
    46  
    47  ```coffeescript
    48  # messagebird
    49  # ##################################
    50  
    51  sendMsg =(body)->
    52    msg = notifr.newMessage();
    53    msg.entity_id = 'messagebird.name';
    54    msg.attributes = {
    55      'phone': '+79990000001',
    56      'body': 'some text'
    57    };
    58    notifr.send(msg);
    59  ```
    60