Amazon Pinpoint · Schema

APNSVoipChannelResponse

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
ApplicationId object
CreationDate object
DefaultAuthenticationMethod object
Enabled object
HasCredential object
HasTokenKey object
Id object
IsArchived object
LastModifiedBy object
LastModifiedDate object
Platform object
Version object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-apns-voip-channel-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-apns-voip-channel-response-schema.json",
  "title": "APNSVoipChannelResponse",
  "description": "Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application that the APNs VoIP channel applies to."
        }
      ]
    },
    "CreationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The date and time when the APNs VoIP channel was enabled."
        }
      ]
    },
    "DefaultAuthenticationMethod": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate."
        }
      ]
    },
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether the APNs VoIP channel is enabled for the application."
        }
      ]
    },
    "HasCredential": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "(Not used) This property is retained only for backward compatibility."
        }
      ]
    },
    "HasTokenKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel."
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility."
        }
      ]
    },
    "IsArchived": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether the APNs VoIP channel is archived."
        }
      ]
    },
    "LastModifiedBy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The user who last modified the APNs VoIP channel."
        }
      ]
    },
    "LastModifiedDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The date and time when the APNs VoIP channel was last modified."
        }
      ]
    },
    "Platform": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP."
        }
      ]
    },
    "Version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The current version of the APNs VoIP channel."
        }
      ]
    }
  },
  "required": [
    "Platform"
  ]
}