Gestione CNAM
Muestre el nombre la persona que llama con el servicio CNAM.
Añada o Cambie CNAM
Use Añadir CNAM para incorporar o cambiar el servicio a una lista de números.
Puntos de conexión y métodos
- POST: /_rest/v3/my/did/cnam
Parámetros
Encabezados
- Aceptar: aplicación/json
- Autorización: xxxxxxxxxxxxxxxxx
- Tipo de contenido: aplicación/json
Campo
Tipo
Descripción
Aceptar
Cadena de caracteres
aplicación/json
Autorización
Cadena de caracteres
Token de autorización (ver Autenticación)
Tipo de
contenidoCadena de caracteres
aplicación/json
Ruta
Campo |
Tipo |
Descripción |
números |
Serie |
Una serie de números de reserva sobre los cuales operar.
Cada elemento se encuentra de la siguiente manera: { «Código de país»: «1», «número»: «2125550001» }
|
cnam |
Cadena de caracteres |
Lectura en etiqueta cnam. Sólo se permiten 15 letras, números o espacios.
|
Correo |
Cadena de caracteres |
Una dirección de correo electrónico para notificar los cambios en este estado de la solicitud.
|
Notas opcional |
Cadena de caracteres
|
Notas sobre el cumplimiento de esta solicitud.
|
ID de |
Cadena de caracteres |
Una cadena de caracteres no vacía que indica su ID o código de referencia. |
Solicitud |
|
{ "cnam": "xxxxxx", "numbers": [ { "countryCode": "1", "number": "2125550001" }, { "countryCode": "1", "number": "2125550002" } ] } |
Ejemplo y esquema de respuesta
Success 200
Campo |
Tipo |
Descripción |
ID de la solicitud |
Número entero |
|
HTTP/1.1 200 OK { "OrderID": 31542 }
Error
Nombre |
Tipo |
Descripción |
código
|
Número entero |
Código de error |
error |
Cadena de caracteres |
Descripción del error |
HTTP/1.1 401 Unauthorized { "code": 401, "error": "Unauthorized" } HTTP/1.1 401 Unauthorized { "code": 401, "error": "Session Expired" }
HTTP/1.1 406 Not Acceptable { "code": 406, "error": "Not Acceptable" }
HTTP/1.1 422 Unprocessable Entity { "code": 422, "error": "The '%s' parameter is required." } HTTP/1.1 422 Unprocessable Entity { "code": 422, "error": "The '%s' parameter must be formatted as a(n) array." } HTTP/1.1 422 Unprocessable Entity { "code": 422, "error": "The '%s' parameter must be formatted as a(n) string." } HTTP/1.1 422 Unprocessable Entity { "code": 422, "error": "The 'numbers' parameter must contain unique numbers." } HTTP/1.1 422 Unprocessable Entity { "code": 422, "error": "The 'cnam' parameter must consist of letters, numbers, or spaces." } HTTP/1.1 422 Unprocessable Entity { "code": 422, "error": "The 'cnam' parameter must be 15 characters or less." }