Vapi · Schema

VonageCredential

AIVoiceAgentsRealtimeCPaaS

Properties

Name	Type	Description
vonageApplicationPrivateKey	string	This is not returned in the API.
provider	string
apiSecret	string	This is not returned in the API.
id	string	This is the unique identifier for the credential.
orgId	string	This is the unique identifier for the org that this credential belongs to.
createdAt	string	This is the ISO 8601 date-time string of when the credential was created.
updatedAt	string	This is the ISO 8601 date-time string of when the assistant was last updated.
vonageApplicationId	string	This is the Vonage Application ID for the credential. Only relevant for Vonage credentials.
name	string	This is the name of credential. This is just for your reference.
apiKey	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VonageCredential",
  "title": "VonageCredential",
  "type": "object",
  "properties": {
    "vonageApplicationPrivateKey": {
      "type": "string",
      "description": "This is not returned in the API.",
      "maxLength": 10000
    },
    "provider": {
      "type": "string",
      "enum": [
        "vonage"
      ]
    },
    "apiSecret": {
      "type": "string",
      "description": "This is not returned in the API."
    },
    "id": {
      "type": "string",
      "description": "This is the unique identifier for the credential."
    },
    "orgId": {
      "type": "string",
      "description": "This is the unique identifier for the org that this credential belongs to."
    },
    "createdAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the credential was created."
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string",
      "description": "This is the ISO 8601 date-time string of when the assistant was last updated."
    },
    "vonageApplicationId": {
      "type": "string",
      "description": "This is the Vonage Application ID for the credential.\n\nOnly relevant for Vonage credentials.",
      "maxLength": 10000
    },
    "name": {
      "type": "string",
      "description": "This is the name of credential. This is just for your reference.",
      "minLength": 1,
      "maxLength": 40
    },
    "apiKey": {
      "type": "string"
    }
  },
  "required": [
    "vonageApplicationPrivateKey",
    "provider",
    "apiSecret",
    "id",
    "orgId",
    "createdAt",
    "updatedAt",
    "vonageApplicationId",
    "apiKey"
  ]
}