CapabilityQueryRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/sinch/main/json-schema/sinch-capability-query-request-schema.json",
  "title": "CapabilityQueryRequest",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/sinch-capability-api-openapi.yml#/components/schemas/CapabilityQueryRequest",
  "type": "object",
  "required": [
    "app_id",
    "recipient"
  ],
  "properties": {
    "app_id": {
      "type": "string",
      "description": "The app ID"
    },
    "recipient": {
      "type": "object",
      "description": "The recipient to query capability for",
      "properties": {
        "contact_id": {
          "type": "string",
          "description": "The contact ID"
        },
        "identified_by": {
          "type": "object",
          "description": "Channel identity to query",
          "properties": {
            "channel_identities": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/ChannelIdentity"
              }
            }
          }
        }
      }
    }
  },
  "$defs": {
    "ChannelIdentity": {
      "type": "object",
      "properties": {
        "channel": {
          "type": "string",
          "enum": [
            "SMS",
            "RCS",
            "WHATSAPP",
            "MESSENGER",
            "INSTAGRAM",
            "VIBER",
            "VIBERBM",
            "TELEGRAM",
            "KAKAOTALK",
            "LINE",
            "MMS"
          ],
          "description": "The channel type"
        },
        "identity": {
          "type": "string",
          "description": "The channel-specific identity"
        },
        "app_id": {
          "type": "string",
          "description": "The app ID for the channel"
        }
      }
    }
  }
}