Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • type – to determine appropriate content in the dynamic template, one of values:

    • bookingConfirmation – Customer created booking

    • bookingReminder – Booking reminder for customer

    • bookingActivated – Booking is activate and is a queue ticket now

    • positionCancelled – staff removed future booking created by the customer

    • positionCalled – Position called by staff

    • positionRetry – staff pressed ‘Retry’ because customer did not show up

    • positionReject – staff pressed ‘Reject’ to remove ticket

  • position – ticket information, including dates, labels, language and more information that can be should be used in the template

  • actionLink – link to present to customer, link depends on email type (see below)

Example of dataTemplate by type:

  1. bookingConfirmation:

    Code Block
    {
        "position":
          {
            "id": "_id_",
            "location": null,
            "type": "booking",
            "priority": 100,
            "locale": "en",
            "notification": {
                "type": "phoneNumber",
                "settings": {
                    "from": "",
                    "to": "+phoneNumber"

...

  1. 
           

...

  1.      },
            },
            "booking": {
                "start": "yyyy-MM-dd HH:mm", // with respect to timezone
                "end": "yyyy-MM-dd HH:mm" // with respect to timezone
            },
            "status": "draft",
            "label": "", // label will generated when time comes
            "queue": "_queue_id_",
            "createdAt": "2020-05-26T08:47:37.1700000Z",
            "fulfilledAt": "2020-05-26T17:15:59.6100000Z",
            "bookingReminderAt": null
      

...

Template by type:

  1. bookingConfirmation:

    Code Block
    {  },
        "positiontype": {"bookingConfirmation",
            "localeactionLink": "en",https://queue.qa.ombori.com/ombori-demo/queues/36a4bdd7-7145-48f9-be92-0fd659f96f92/positions/1c645e74-edd8-48ed-b5c7-3c48fa715c8a"    
    }

    Code Block
    <html><head><title></title></head>
      <body>
    

    "booking": {

      <div data-role="module-unsubscribe" class="module" role="module" 

    "start": "yyyy-MM-dd HH:mm" }

    data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
        
        <p>    

    },

        
    

    "actionLink":

     

    "linkToTicket"

       {{#equals position.locale 

    }

    Code Block
    <html><head><title></title></head>"ar"}}
       <body>   <div data-role="module-unsubscribe" class="module" role="module" data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5"> حجزك لـ ‪{{position.date}}‬ مؤكد الآن.
            تذكرة: ‪{{actionLink}}‬
        {{else}}
            Your booking for {{position.booking.start}} is now confirmed. Ticket: {{actionLink}}
        {{/equals}}
        </p>        
        
      </div>
    </body>
    </html>

  2. bookingReminder:

    Code Block
    {
        "position":
          {
            "id": "_id_",
            "location": null,
            "type": "booking",
            "priority": 100,
            "locale": "en",
            "notification": {
                "type": "phoneNumber",
                "settings": {
                    "from": "",
                    "to": "+phoneNumber"
                },
            },
            "booking": {
                "start": "yyyy-MM-dd HH:mm", // with respect to timezone
                "end": "yyyy-MM-dd HH:mm" // with respect to timezone
            },
            "status": "draft",
            "label": "", // label will generated when time comes
            "queue": "_queue_id_",
            "createdAt": "2020-05-26T08:47:37.1700000Z",
            "fulfilledAt": "2020-05-26T17:15:59.6100000Z",
            "bookingReminderAt": null
        },
        "type": "bookingReminder",
        "actionLink": "https://queue.qa.ombori.com/ombori-demo/queues/36a4bdd7-7145-48f9-be92-0fd659f96f92/positions/1c645e74-edd8-48ed-b5c7-3c48fa715c8a"    
    }

    Code Block
    
      <html>
        <head>
          <title></title>
        </head>
        <body>
          <div data-role="module-unsubscribe" class="module" role="module" data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
          
            <p>        
            {{#equals position.locale "ar"}}
                لا تنس حجزك في 
            {{else}}
                Don't forget your booking in 15 minutes
            {{/equals}}
            </p>
                
          </div>
        </body>
      </html>
    

  3. bookingActivated:

    Code Block
    {
        "position":
          {
            "id": "_id_",
            "location": null,
            "type": "booking",
            "priority": 100,
            "locale": "en",
            "notification": {
                "type": "phoneNumber",
                "settings": {
                    "from": "",
                    "to": "+phoneNumber"
                },
            },
            "booking": {
                "start": "yyyy-MM-dd HH:mm", // with respect to timezone
                "end": "yyyy-MM-dd HH:mm" // with respect to timezone
            },
            "status": "pending",
            "label": "B1",
            "queue": "_queue_id_",
            "createdAt": "2020-05-26T08:47:37.1700000Z",
            "fulfilledAt": "2020-05-26T17:15:59.6100000Z",
            "bookingReminderAt": null
        },
        "type": "bookingActivated",
        "actionLink": "https://queue.qa.ombori.com/ombori-demo/queues/36a4bdd7-7145-48f9-be92-0fd659f96f92/positions/1c645e74-edd8-48ed-b5c7-3c48fa715c8a"    
    }

    Code Block
    
      <html>
        <head>
          <title></title>
        </head>
        <body>
          <div data-role="module-unsubscribe" class="module" role="module" data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
            
            <p>        
            {{#equals position.locale "ar"}}
    "رقم موعدك: ‪{{position.label}}‬. يرجى الحضور في خلال 15 دقيقة لتجنب إلغاء الموعد تذكرة: ‪{{actionLink}}‬" 
            {{else}}
                Your position: {{position.label}}. Please come within 15 minutes to avoid cancellation of your appointment. Ticket: {{actionLink}}
            {{/equals}}
            </p>
                
          </div>
        </body>
      </html>
    

  4. positionCancelled:

    Code Block
    {
        "position":
          {
            "id": "_id_",
            "location": null,
            "type": "booking",
            "priority": 100,
            "locale": "en",
            "notification": {
                "type": "phoneNumber",
                "settings": {
                    "from": "",
                    "to": "+phoneNumber"
                },
            },
            "booking": {
                "start": "yyyy-MM-dd HH:mm", // with respect to timezone
                "end": "yyyy-MM-dd HH:mm" // with respect to timezone
            },
            "status": "draft",
            "label": "B1",
            "queue": "_queue_id_",
            "createdAt": "2020-05-26T08:47:37.1700000Z",
            "fulfilledAt": "2020-05-26T17:15:59.6100000Z",
            "bookingReminderAt": null
        },
        "type": "positionCancelled",
        "actionLink": "https://queue.qa.ombori.com/ombori-demo/queues/36a4bdd7-7145-48f9-be92-0fd659f96f92/book"    
    }

    Code Block
    
      <html>
        <head>
          <title></title>
        </head>
        <body>
          <div data-role="module-unsubscribe" class="module" role="module" data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
            
            <p>        
            {{#equals position.locale "ar"}}
                تم إلغاء الحجز. {{position.label}} برجاء زيارة {{actionLink}} إذا كنت ترغب في حجز موعد جديد
            {{else}}
    <p>            Position {{#equals position.locale "ar"position.label}} was cancelled. Visit {{actionLink}} if you would like to request a  حجزك لـ ‪{{position.date}}‬ مؤكد الآن.new position.
            {{/equals}}
            </p>
       تذكرة: ‪{{actionLink}}‬     {{else}}   
         Your booking</div>
    for {{position.booking.start}} is now confirmed. Ticket: {{actionLink}}
        {{/equals}}
        </p></body>
      </html>
    

  5. positionCalled

    Code Block
    {
        "position":
          {
            "id": "_id_",
     
    </div>
     
    </body>
     
    </html>

    bookingReminder:

    Code Block
    {     "positionlocation": {null,
            "localetype": "enbooking",
            }"priority": 100,
            "actionLinklocale": "timeForReminderen",
            "notification": {
     }
    Code Block
       
    <html>
         
    <head>
       "type": "phoneNumber",
      
    <title></title>
         
    </head>
         
    <body>
    "settings": {
        
    <div
     
    data-role="module-unsubscribe"
     
    class="module"
     
    role="module"
     
    data-type="unsubscribe"
     
    style="color:#444444;
     
    font-size:12px;
     
    line-height:20px;
     
    padding:16px
     
    16px
     
    16px
     
    16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
     "from": "",
                    "to": "+phoneNumber"
      
    <p>
              },
          
    {{#equals
     
    position.locale
     
    "ar"}}
    },
            "booking": {
        
    لا
     
    تنس
     
    حجزك
     
    في
     
    ‪{{actionLink}}‬
        "start": "yyyy-MM-dd HH:mm", // with 
    {{else}}
    respect to timezone
              
    Don't
     
    forget
     
    your booking in {{actionLink}}
    "end": "yyyy-MM-dd HH:mm" // with respect to timezone
        
    {{/equals}}
        },
        
    </p>
        "status": "pending",
            "label": "B1",
        
    </div>
        
    </body>
    "queue": "_queue_id_",
      
    </html>
     

    bookingActivated:

    Code Block
    {     "positioncreatedAt": {"2020-05-26T08:47:37.1700000Z",
            "localefulfilledAt": "en2020-05-26T17:15:59.6100000Z",
            "labelbookingReminderAt": "B1"null
        },
        "type": "positionCalled",
      },     "actionLink": "linkToTicket""actionLink": "https://queue.qa.ombori.com/ombori-demo/queues/36a4bdd7-7145-48f9-be92-0fd659f96f92/positions/1c645e74-edd8-48ed-b5c7-3c48fa715c8a"    
    
    }

    Code Block
      <html>
        <head>
          <title></title>
        </head>
        <body>
          <div data-role="module-unsubscribe" class="module" role="module" data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
            
            <p>        
            {{#equals position.locale "ar"}}
    "رقم موعدك: ‪{{position.label}}‬. يرجى الحضور في خلال 15 دقيقة لتجنب إلغاء الموعد تذكرة: ‪{{actionLink}}‬" position.locale "ar"}}
                حان دورك الآن.
            {{else}}
                It is your turn now.
            {{/equals}}
             {{else}}</p>
                
    Your position: {{position.label}}. Please come within 15</div>
    minutes to avoid cancellation of</body>
    your appointment. Ticket: {{actionLink}} </html>
    

  6. positionRetry

    Code Block
    {
        
    "position":
      
    {{/equals}}
        {
        
    </p>
        "id": "_id_",
            "location": null,
        
    </div>
        
    </body>
    "type": "booking",
      
    </html>
     

    positionCancelled:

    Code Block
    {     "positionpriority": {100,
            "locale": "en",
            "labelnotification": "B1"{
                },
        "actionLink"type": "linkToQueueForGettingNewTicketphoneNumber",
        }
    Code Block
       
    <html>
         
    <head>
    "settings": {
         
    <title></title>
         
    </head>
         
    <body> <div data-role="module-unsubscribe"
     
    class=
    "
    module
    from": 
    role=
    "
    module
    "
    data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
    ,
                    "to": "+phoneNumber"
                },
        
    <p>
        },
            "booking": {
      
    {{#equals position.locale "ar"}}
              "start": "yyyy-MM-dd HH:mm", // with respect to 
    تم
    timezone
    
    إلغاء
     
    الحجز.
     
    {{position.label}}
     
    برجاء
     
    زيارة
     
    {{actionLink}}
     
    إذا
     
    كنت
     
    ترغب
     
    في
     
    حجز
     
    موعد
     
    جديد {{else}}
    "end": "yyyy-MM-dd HH:mm" // with respect to timezone
            },
         
    Position
     
    {{position.label}}
     
    was cancelled. Visit {{actionLink}} if you would like to request a new position.
     "status": "pending",
            "label": "B1",
            
    {{/equals}}
    "queue": "_queue_id_",
           
    </p>
     "createdAt": "2020-05-26T08:47:37.1700000Z",
            "fulfilledAt": "2020-05-26T17:15:59.6100000Z",
           
    </div>
     "bookingReminderAt": null
      
    </body>
      
    </html>

    positionCalled

    Code Block
    {},
         "positiontype": {
    "positionRetry",
           "localeactionLink": "en"       "https://queue.qa.ombori.com/ombori-demo/queues/36a4bdd7-7145-48f9-be92-0fd659f96f92/positions/1c645e74-edd8-48ed-b5c7-3c48fa715c8a"    
     }    
    }

    Code Block
      <html>
        <head>
          <title></title>
        </head>
        <body>
          <div data-role="module-unsubscribe" class="module" role="module" data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
            
            <p>        
            {{#equals position.locale "ar"}}.locale "ar"}}
                تم الوصول لدورك، لكنك لم تدخل. سنحاول مرة أخرى في غضون دقائق قليلة. الرجاء الإقتراب من المدخل
            {{else}}
       حان دورك الآن.       We called {{else}}
                It is your turn nowyour ticket, but did not find you. We will try again in few minutes. Please approach the entrance.
            {{/equals}}
            </p>
                
          </div>
        </body>
      </html>
    

    positionRetry

  7. Code Block

    positionReject

    Code Block
    {
        "position":
          {
            "positionid": {"_id_",
            "localelocation": "en"null,
            "type": "booking",
      }    }
    Code Block
      
    <html>
    "priority": 100,
        
    <head>
        "locale": "en",
     
    <title></title>
         
    </head>
      "notification": {
     
    <body>
           
    <div data-role="module-unsubscribe" class="module" role="module" data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
        "type": "phoneNumber",
                "settings": {
                    
    <p>
    "from": "",
                   
    {{#equals position.locale
     "to": "
    ar"}}
    +phoneNumber"
                },
          
    تم
      },
    
    الوصول
     
    لدورك،
     
    لكنك
     
    لم
     
    تدخل.
     
    سنحاول
     
    مرة
     
    أخرى
     
    في غضون دقائق قليلة. الرجاء الإقتراب من المدخل
    "booking": {
                "start": 
    {{else}}
    "yyyy-MM-dd HH:mm", // with respect to timezone
           
    We
     
    called
     
    your
     
    ticket,
     
    but
     
    did not find you. We will try again in few minutes. Please approach the entrance.
    "end": "yyyy-MM-dd HH:mm" // with respect to timezone
            },
         
    {{/equals}}
       "status": "cancelled",
        
    </p>
        "label": "B1",
            "queue": "_queue_id_",
        
    </div>
        
    </body> </html>

    positionReject

    Code Block
    {"createdAt": "2020-05-26T08:47:37.1700000Z",
            "positionfulfilledAt": {"2020-05-26T17:15:59.6100000Z",
            "localebookingReminderAt": "en",null
        },
        "labeltype": "B1"
        }positionReject",
        "actionLink": "linkToQueueForGettingNewTicket"https://queue.qa.ombori.com/ombori-demo/queues/36a4bdd7-7145-48f9-be92-0fd659f96f92"    
    }  

    Code Block
      <html>
        <head>
          <title></title>
        </head>
        <body>
          <div data-role="module-unsubscribe" class="module" role="module" data-type="unsubscribe" style="color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;" data-muid="4e838cf3-9892-4a6d-94d6-170e474d21e5">
            
            <p>        
            {{#equals position.locale "ar"}}
                تم إلغاء الحجز. {{position.label}} برجاء زيارة {{actionLink}} إذا كنت ترغب في حجز موعد جديد
            {{else}}
                Position {{position.label}} was cancelled. Visit {{actionLink}} if you would like to request a new position.
            {{/equals}}
            </p>
                
          </div>
        </body>
      </html>
    

...