Amazon Pinpoint · Schema

VoiceChannelResponse

Provides information about the status and settings of the voice channel for an application.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

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

JSON Schema

amazon-pinpoint-voice-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-voice-channel-response-schema.json",
  "title": "VoiceChannelResponse",
  "description": "Provides information about the status and settings of the voice channel for an application.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application that the voice channel applies to."
        }
      ]
    },
    "CreationDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The date and time, in ISO 8601 format, when the voice channel was enabled."
        }
      ]
    },
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether the voice channel is enabled for the application."
        }
      ]
    },
    "HasCredential": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "(Not used) This property is retained only for backward compatibility."
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "(Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility."
        }
      ]
    },
    "IsArchived": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__boolean"
        },
        {
          "description": "Specifies whether the voice channel is archived."
        }
      ]
    },
    "LastModifiedBy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The user who last modified the voice channel."
        }
      ]
    },
    "LastModifiedDate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The date and time, in ISO 8601 format, when the voice channel was last modified."
        }
      ]
    },
    "Platform": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE."
        }
      ]
    },
    "Version": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The current version of the voice channel."
        }
      ]
    }
  },
  "required": [
    "Platform"
  ]
}