Webex · Schema

GetContactListsResponse

Response containing a list of contact lists

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
outcome	string	Outcome of the operation
statusCode	integer	0 for success, non-zero for failure or validation failure
contactLists	array	List of contact lists

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetContactListsResponse",
  "title": "GetContactListsResponse",
  "type": "object",
  "description": "Response containing a list of contact lists",
  "properties": {
    "outcome": {
      "type": "string",
      "enum": [
        "Success",
        "Failure"
      ],
      "description": "Outcome of the operation"
    },
    "statusCode": {
      "type": "integer",
      "description": "0 for success, non-zero for failure or validation failure"
    },
    "contactLists": {
      "type": "array",
      "description": "List of contact lists",
      "items": {
        "type": "object",
        "properties": {
          "contactListId": {
            "type": "string",
            "description": "Contact List ID",
            "example": "501"
          },
          "contactListStatus": {
            "type": "string",
            "description": "Contact List Status",
            "example": "Active"
          },
          "contactListRecordProcessed": {
            "type": "integer",
            "description": "Number of records in the contact list",
            "example": 100
          },
          "contactListSource": {
            "type": "string",
            "description": "Source of the contact list",
            "example": "API"
          },
          "dateOfCreation": {
            "type": "string",
            "format": "date-time",
            "description": "Date of creation",
            "example": "2025-08-01T10:00:00Z"
          },
          "dateOfActivation": {
            "type": "string",
            "format": "date-time",
            "description": "Date of activation",
            "example": "2025-08-01T12:00:00Z"
          },
          "dateOfExpiry": {
            "type": "string",
            "format": "date-time",
            "description": "Date of expiry",
            "example": "2025-09-01T00:00:00Z"
          }
        }
      }
    }
  },
  "example": {
    "outcome": "Success",
    "statusCode": 0,
    "contactLists": [
      {
        "contactListId": "501",
        "contactListStatus": "Active",
        "contactListRecordProcessed": 100,
        "contactListSource": "API",
        "dateOfCreation": "2025-08-01T10:00:00",
        "dateOfActivation": "2025-08-01T12:00:00",
        "dateOfExpiry": "2025-09-01T00:00:00"
      }
    ]
  }
}