Messages

Create a message

post

Create a message to the queue, ready to be processed

Authorizations

Body

topicstringOptional

titlestringOptional

messagestringOptional

soundstringOptional

priorityintegerOptional

expiry_ttlintegerOptional

requires_acknowledgementbooleanOptional

Responses

default

Message Create Body

application/json

post

HTTPcURLJavaScriptPython

POST /messages HTTP/1.1
Host: api.justpush.io
Authorization: Bearer Token
Content-Type: application/json
Accept: */*
Content-Length: 522

{
  "topic": "text",
  "title": "text",
  "message": "text",
  "sound": "text",
  "priority": 1,
  "expiry_ttl": 1,
  "requires_acknowledgement": true,
  "acknowledgement": {
    "requires_retry": true,
    "max_retries": 1,
    "interval": 1,
    "callback": {
      "required": true,
      "url": "text",
      "params": "text"
    }
  },
  "buttons": [
    {
      "cta": "text",
      "url": "text",
      "action_required": true
    }
  ],
  "buttons_groups": [
    {
      "name": "text",
      "cta": "text",
      "action_required": "text",
      "buttons": [
        {
          "cta": "text",
          "url": "text"
        }
      ]
    }
  ],
  "images": [
    {
      "caption": "A simple Caption",
      "url": "https://picsum.photos/200/300",
      "body": "text"
    }
  ]
}

default

Message Create Body

{
  "status": true,
  "message": "text"
}

Get a message

get

Get a message based on the Key provided when the message got created.

Authorizations

Path parameters

messageKeystringRequired

Responses

default

Message Get Body

application/json

get

HTTPcURLJavaScriptPython

GET /messages/{messageKey} HTTP/1.1
Host: api.justpush.io
Authorization: Bearer Token
Accept: */*

default

Message Get Body

{
  "topic": "text",
  "title": "text",
  "message": "text",
  "sound": "text",
  "priority": 1,
  "expiry_ttl": 1,
  "requires_acknowledgement": true,
  "acknowledgement": {
    "requires_retry": true,
    "max_retries": 1,
    "interval": 1,
    "callback": {
      "required": true,
      "url": "text",
      "params": "text"
    }
  },
  "buttons": [
    {
      "cta": "text",
      "url": "text",
      "action_required": true
    }
  ],
  "buttons_groups": [
    {
      "name": "text",
      "cta": "text",
      "action_required": "text",
      "buttons": [
        {
          "cta": "text",
          "url": "text"
        }
      ]
    }
  ],
  "images": [
    {
      "caption": "text",
      "url": "text",
      "body": "text"
    }
  ]
}