Mod sender (v1)

http://api.example.com/{version}

Table of contents

/message-delivery

POST /message-delivery

Send prepered notification to delivery channels

POST /message-delivery
Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "Notification containing messages to be sent",
  "additionalProperties": false,
  "properties": {
    "notificationId": {
      "type": "string",
      "description": "Notification id; UUID format; Is used to receive notification when messages are delivered"
    },
    "recipientUserId": {
      "type": "string",
      "description": "Recipient user id; Is used to get contact information to deliver messages"
    },
    "messages": {
      "type": "array",
      "description": "Array of messages to be sent",
      "items": {
        "type": "object",
        "$ref": "message.json"
      }
    }
  },
  "required": [
    "notificationId",
    "recipientUserId",
    "messages"
  ]
}

Response 204

Body

Media type: text/plain

Type: any

Response 400

Bad request

Body

Media type: text/plain

Type: any

Example:

Bad request

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error