Check push

v1.0.0

Sends a test message via push, this is a test endpoint to verify your push settings

Input

{
  "type": "object",
  "properties": {
    "apn_template": {
      "type": "string",
      "description": "Push message template for APN"
    },
    "firebase_data_template": {
      "type": "string",
      "description": "Push message data template for Firebase"
    },
    "firebase_template": {
      "type": "string",
      "description": "Push message template for Firebase"
    },
    "message_id": {
      "type": "string",
      "description": "Message ID to send push notification for"
    },
    "push_provider_name": {
      "type": "string",
      "description": "Name of push provider"
    },
    "push_provider_type": {
      "type": "string",
      "description": "Push provider type",
      "enum": [
        "firebase",
        "apn",
        "huawei",
        "xiaomi"
      ]
    },
    "skip_devices": {
      "type": "boolean",
      "description": "Don't require existing devices to render templates"
    },
    "user": {
      "type": "object",
      "description": "Represents chat user",
      "required": [
        "id"
      ],
      "properties": {
        "ban_expires": {
          "type": "string",
          "format": "date-time",
          "description": "Expiration date of the ban"
        },
        "banned": {
          "type": "boolean",
          "description": "Whether a user is banned or not"
        },
        "id": {
          "type": "string",
          "description": "Unique user identifier"
        },
        "invisible": {
          "type": "boolean"
        },
        "language": {
          "type": "string",
          "description": "Preferred language of a user"
        },
        "push_notifications": {
          "type": "object",
          "properties": {
            "disabled": {
              "type": "boolean"
            },
            "disabled_until": {
              "type": "string",
              "format": "date-time"
            }
          }
        },
        "revoke_tokens_issued_before": {
          "type": "string",
          "format": "date-time",
          "description": "Revocation date for tokens"
        },
        "role": {
          "type": "string",
          "description": "Determines the set of user permissions"
        },
        "teams": {
          "type": "array",
          "description": "List of teams user is a part of",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "user_id": {
      "type": "string"
    }
  }
}

Output

{
  "type": "object",
  "required": [
    "duration"
  ],
  "properties": {
    "device_errors": {
      "type": "object",
      "description": "Object with device errors"
    },
    "duration": {
      "type": "string"
    },
    "general_errors": {
      "type": "array",
      "description": "List of general errors",
      "items": {
        "type": "string"
      }
    },
    "rendered_apn_template": {
      "type": "string"
    },
    "rendered_firebase_template": {
      "type": "string"
    },
    "rendered_message": {
      "type": "object"
    },
    "skip_devices": {
      "type": "boolean",
      "description": "Don't require existing devices to render templates"
    }
  }
}