number-details-update

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vonage/main/json-schema/vonage-number-details-update-schema.json",
  "title": "number-details-update",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vonage-numbers-openapi.yml#/components/schemas/number-details-update",
  "type": "object",
  "properties": {
    "country": {
      "$ref": "#/$defs/country"
    },
    "msisdn": {
      "type": "string",
      "description": "An available inbound virtual number."
    },
    "app_id": {
      "type": "string",
      "description": "The Application that will handle inbound traffic to this number."
    },
    "moHttpUrl": {
      "description": "An URL-encoded URI to the webhook endpoint that handles inbound messages. Your webhook endpoint must be active before you make this request. Vonage makes a `GET` request to the endpoint and checks that it returns a `200 OK` response. Set this parameter's value to an empty string to remove the webhook.",
      "type": "string"
    },
    "moSmppSysType": {
      "description": "The associated system type for your SMPP client",
      "type": "string"
    },
    "voiceCallbackType": {
      "description": "Specify whether inbound voice calls on your number are forwarded\nto a SIP or a telephone number.  This must be used with the\n`voiceCallbackValue` parameter. If set, `sip` or `tel` are\nprioritized over the Voice capability in your Application.\n\n*Note: The `app` value is deprecated and will be removed in future.*\n",
      "type": "string",
      "enum": [
        "sip",
        "tel",
        "app"
      ]
    },
    "voiceCallbackValue": {
      "description": "A SIP URI or telephone number. Must be used with the `voiceCallbackType` parameter.",
      "type": "string"
    },
    "voiceStatusCallback": {
      "description": "A webhook URI for Vonage to send a request to when a call ends",
      "type": "string"
    },
    "messagesCallbackType": {
      "description": "<strong>DEPRECATED</strong> - We recommend that you use `app_id` instead.\n\nSpecifies the Messages webhook type (always `app`) associated with this\nnumber and must be used with the `messagesCallbackValue` parameter.\n",
      "type": "string",
      "enum": [
        "app"
      ],
      "deprecated": true
    },
    "messagesCallbackValue": {
      "description": "<strong>DEPRECATED</strong> - We recommend that you use `app_id` instead.\n\nSpecifies the Application ID of your Messages application.\nIt must be used with the `messagesCallbackType` parameter.\n",
      "type": "string",
      "deprecated": true
    }
  },
  "required": [
    "country",
    "msisdn"
  ],
  "$defs": {
    "country": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2,
      "description": "The two character country code in ISO 3166-1 alpha-2 format"
    }
  }
}