Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Delivery

  1. Create a template with local_time, mobile_overdue_strategy, mobile_sendout_strategy.
    Use the following JSON payload as example:
    {
    "campaign_id": "161156",
    "application_id": "103012",
    "sound": "default",
    "name": "Test name",
    "description": "Test description",
    "type": 5,
    "content_type": 1,
    "push_body": "Test message (body)",
    "overdue": 0, // or 1 or 2
     "schedule_type": 1, // or 4 for best time
    "schedule_date": "1425130929"
    }

    overdue - the overdue policy that will be applied to the message. 0 for now, 1 for never, and 2 for next day.
    schedule_type - the sendout strategy that will be used. 1 signifies local time, which is the only relevant value for this flow
    schedule_date - the UNIX timestamp of the local schedule date. For example, if all devices should receive the message on 2015-11-10 16:00 in their country's time, then the value will be equivalent to MySQL's UNIX_TIMESTAMP('2015-11-10 16:00') which is 1447171200.

  2. Trigger the message like a regular template message (such as in direct message). Info available here.
    1. If this is a Local Time message, trigger the message at UTC-16
    2. If this is a Best Time message, trigger the message at 09:00 UTC at the day before the schedule_date

 

Value mapping

Overdue strategy

strategy

code
now0
never1
next day2

 

Schedule type

strategycode
now0

local

1
BTTS schedule4

 

Cancellation

A pending or processing local message can be cancelled using the following API:

Verb

Code Block
languagetext
PUT

URI

Code Block
languagetext
http://<hostname>/api/v3/message/direct/cancel

Body

Code Block
languagejs
{
    "app_id": 1234,
    "message_id": 1234
}