Patch Sip Configuration - Patch Sip Configuration

Servicio:

Communication

Versión de la API:

2021-05-01-preview

Aplica revisiones a la configuración de SIP para el recurso.

PATCH {endpoint}/sip?api-version=2021-05-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Recurso de comunicación, por ejemplo, https://resourcename.communication.azure.com
api-version	query	True	string	Versión de la API que se va a invocar

Cuerpo de la solicitud

Media Types: "application/merge-patch+json"

Nombre	Tipo	Description
routes	TrunkRoute[]	Rutas de tronco para las llamadas de enrutamiento.
trunks	<string,  TrunkPatch>	Troncos SIP para las llamadas de enrutamiento. La clave de asignación es el FQDN del tronco (1-249 caracteres).

Respuestas

Nombre	Tipo	Description
200 OK	SipConfiguration	Se devuelve la configuración revisada.
422 Unprocessable Entity	CommunicationErrorResponse	Si la solicitud está vacía, incoherente o incoherente con los datos almacenados.
500 Internal Server Error	CommunicationErrorResponse	Todos los demás errores de API.
Other Status Codes	CommunicationErrorResponse	Tipo de medio no admitido de la revisión.
Other Status Codes	CommunicationErrorResponse	Fracaso

Ejemplos

Patch SIP configuration for resource

Solicitud de ejemplo

HTTP

PATCH https://resourcename.communication.azure.com//sip?api-version=2021-05-01-preview

{
  "trunks": {
    "vendor.xyz.biz": {
      "sipSignalingPort": 5061
    }
  },
  "routes": [
    {
      "name": "VendorXYZ",
      "description": "External route XYZ",
      "numberPattern": "^\\+?\\d+$",
      "trunks": [
        "vendor.xyz.biz"
      ]
    }
  ]
}

Respuesta de muestra

status code:

200

{
  "trunks": {
    "vendor.xyz.biz": {
      "sipSignalingPort": 5061
    }
  },
  "routes": [
    {
      "name": "VendorXYZ",
      "description": "External route XYZ",
      "numberPattern": "^\\+?\\d+$",
      "trunks": [
        "vendor.xyz.biz"
      ]
    }
  ]
}

status code:

415

{
  "error": {
    "code": "UnsupportedMediaType",
    "message": "Unsupported Media Type."
  }
}

status code:

422

{
  "error": {
    "code": "UnprocessableEntity",
    "message": "One or more request inputs are not valid.",
    "innererror": {
      "code": "InvalidRegex",
      "message": "Unsupported regex format provided."
    }
  }
}

status code:

500

{
  "error": {
    "code": "InternalError",
    "message": "The server encountered an internal error."
  }
}

Definiciones

Nombre	Description
CommunicationError	Error de Communication Services.
CommunicationErrorResponse	Error de Communication Services.
SipConfiguration	Representa una configuración SIP. Cuando se enruta una llamada, las rutas se aplican en el mismo orden que en la lista de rutas. Una ruta coincide con su patrón de número. A continuación, la llamada se dirige al primer tronco disponible de la ruta, en función del orden de la lista de troncos de la ruta.
SipConfigurationPatch	Representa una revisión de configuración sip.
Trunk	Representa un tronco SIP para las llamadas de enrutamiento. Consulte RFC 4904.
TrunkPatch	Representa una revisión de tronco SIP.
TrunkRoute	Representa una ruta de tronco para las llamadas de enrutamiento.

CommunicationError

Object

Error de Communication Services.

Nombre	Tipo	Description
code	string	Código de error.
details	CommunicationError[]	Más detalles sobre los errores específicos que llevaron a este error.
innererror	CommunicationError	Error interno si existe.
message	string	Mensaje de error.
target	string	Destino del error.

CommunicationErrorResponse

Object

Error de Communication Services.

Nombre	Tipo	Description
error	CommunicationError	Error de Communication Services.

SipConfiguration

Object

Representa una configuración SIP. Cuando se enruta una llamada, las rutas se aplican en el mismo orden que en la lista de rutas. Una ruta coincide con su patrón de número. A continuación, la llamada se dirige al primer tronco disponible de la ruta, en función del orden de la lista de troncos de la ruta.

Nombre	Tipo	Description
routes	TrunkRoute[]	Rutas de tronco para las llamadas de enrutamiento.
trunks	<string,  Trunk>	Troncos SIP para las llamadas de enrutamiento. La clave de asignación es el FQDN del tronco (1-249 caracteres).

SipConfigurationPatch

Object

Representa una revisión de configuración sip.

Nombre	Tipo	Description
routes	TrunkRoute[]	Rutas de tronco para las llamadas de enrutamiento.
trunks	<string,  TrunkPatch>	Troncos SIP para las llamadas de enrutamiento. La clave de asignación es el FQDN del tronco (1-249 caracteres).

Trunk

Object

Representa un tronco SIP para las llamadas de enrutamiento. Consulte RFC 4904.

Nombre	Tipo	Description
sipSignalingPort	integer (int32)	Obtiene o establece el puerto de señalización SIP del tronco.

TrunkPatch

Object

Representa una revisión de tronco SIP.

Nombre	Tipo	Description
sipSignalingPort	integer (int32)	Obtiene o establece el puerto de señalización SIP del tronco.

TrunkRoute

Object

Representa una ruta de tronco para las llamadas de enrutamiento.

Nombre	Tipo	Description
description	string maxLength: 1024	Obtiene o establece la descripción de la ruta.
name	string maxLength: 256	Obtiene o establece el nombre de la ruta.
numberPattern	string maxLength: 1024	Obtiene o establece el patrón de número de expresión regular para las llamadas de enrutamiento. Se admite el formato regex de .NET. La expresión regular solo debe coincidir con dígitos con un prefijo '+' opcional sin espacios. Es decir, "^+[1-9][0-9]{3,23}$".
trunks	string[]	Obtiene o establece la lista de troncos SIP para las llamadas de enrutamiento. Los troncos se representan como FQDN.