cURL

curl -g "https://blindado.medularis.com/calls/80ce31ac-1add-4e4f-92af-df703a5fa2b3" -X GET

Respuesta

Simulated Response

Campos de respuesta

Name	Description
id	Identificador único
status	Estado de la llamada ['Contestada'\|'No contestada']
source	Número quien realizó la llamada
destination	Número donde se recibió la llamada
duration	Segundos de duración del origen `source`
bill_sec	Segundos de duración del destino `destination`
created_at	Fecha y Hora en formato UTC ISO 8601 cuando fue de la llamada
time_now	Fecha y Hora en formato UTC ISO 8601 actual en el servidor
url	URL donde descargar audio de la llamada

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
  "id": "80ce31ac-1add-4e4f-92af-df703a5fa2b3",
  "source": "123456789",
  "destination": "987654321",
  "duration": 0,
  "status": "En Ejecución",
  "forward_request_id": "c36dda06-c314-44d8-bb0d-856a0948ca6a",
  "bill_sec": 0,
  "created_at": "2020-02-24T18:40:04Z",
  "updated_at": "2020-02-24T18:40:04Z",
  "url": "http://example.org/calls/80ce31ac-1add-4e4f-92af-df703a5fa2b3/recording"
}

Llamada no existe con ID

No existe la llamada.

Punto de llegada

GET /calls/80ce31ac-1add-4e4f-92af-df703a5fa2b3

Solicitud

Ruta

GET /calls/80ce31ac-1add-4e4f-92af-df703a5fa2b3

cURL

curl -g "https://blindado.medularis.com/calls/80ce31ac-1add-4e4f-92af-df703a5fa2b3" -X GET

Respuesta

Simulated Response

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
}

Con llamadas asociadas

Entrega el listado de llamadas asociados un determinado forward_request filtrado por ID.

Punto de llegada

GET /forward_requests/cda96b5f-e445-48a8-9d11-5753b6605ccf/calls

Solicitud

Ruta

GET /forward_requests/cda96b5f-e445-48a8-9d11-5753b6605ccf/calls

cURL

curl -g "https://blindado.medularis.com/forward_requests/cda96b5f-e445-48a8-9d11-5753b6605ccf/calls" -X GET

Respuesta

Simulated Response

Campos de respuesta

Name	Description
id	Identificador único
status	Estado de la llamada ['Contestada'\|'No contestada']
source	Número quien realizó la llamada
destination	Número donde se recibió la llamada
duration	Segundos de duración del origen `source`
bill_sec	Segundos de duración del destino `destination`
created_at	Fecha y Hora en formato UTC ISO 8601 cuando fue de la llamada
time_now	Fecha y Hora en formato UTC ISO 8601 actual en el servidor
url	URL donde descargar audio de la llamada

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

[
  {
    "id": "e4a6594a-7efc-4272-a726-9de655cce73b",
    "source": "123456789",
    "destination": "987654321",
    "duration": 0,
    "status": "En Ejecución",
    "forward_request_id": "cda96b5f-e445-48a8-9d11-5753b6605ccf",
    "bill_sec": 0,
    "created_at": "2020-02-24T18:40:05Z",
    "updated_at": "2020-02-24T18:40:05Z",
    "url": "http://example.org/calls/e4a6594a-7efc-4272-a726-9de655cce73b/recording"
  },
  {
    "id": "f9349c79-3724-4e25-81c3-81311872636b",
    "source": "987654321",
    "destination": "123456789",
    "duration": 60,
    "status": "Contestada",
    "forward_request_id": "cda96b5f-e445-48a8-9d11-5753b6605ccf",
    "bill_sec": 50,
    "created_at": "2020-02-24T18:40:05Z",
    "updated_at": "2020-02-24T18:40:05Z",
    "url": "http://example.org/calls/f9349c79-3724-4e25-81c3-81311872636b/recording"
  }
]

Sin llamadas realizadas

Punto de llegada

GET /forward_requests/cda96b5f-e445-48a8-9d11-5753b6605ccf/calls

Solicitud

Ruta

GET /forward_requests/cda96b5f-e445-48a8-9d11-5753b6605ccf/calls

cURL

curl -g "https://blindado.medularis.com/forward_requests/cda96b5f-e445-48a8-9d11-5753b6605ccf/calls" -X GET

Respuesta

Simulated Response

Estado

Grabaciones

Cada llamada puede tener asociado un audio de grabación.Estas se almacenan por un periodo determinado.

Grabacion de la llamada

La respuesta es un binario en formato WAV que es la grabación de la llamada.

Punto de llegada

GET /calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording

Solicitud

Ruta

GET /calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording

cURL

curl -g "https://blindado.medularis.com/calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording" -X GET \
	-H "Access-Token: token123"

Respuesta

Simulated Response

Estado

Encabezados

Content-Type: audio/x-wav

Cuerpo

[binary data]

Token no válido

El token enviado en el header no es valido

Punto de llegada

GET /calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording

Solicitud

Ruta

GET /calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording

cURL

curl -g "https://blindado.medularis.com/calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording" -X GET \
	-H "Access-Token: token123"

Respuesta

Simulated Response

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
  "status": "Invalid Access Token"
}

Llamada no existe

No existe la llamada

Punto de llegada

GET /calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording

Solicitud

Ruta

GET /calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording

cURL

curl -g "https://blindado.medularis.com/calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording" -X GET \
	-H "Access-Token: token123"

Respuesta

Simulated Response

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
  "status": "Not Found"
}

No disponible

El audio no esta disponible

Punto de llegada

GET /calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording

Solicitud

Ruta

GET /calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording

cURL

curl -g "https://blindado.medularis.com/calls/0034e7db-4564-46cc-84ba-28f19033c13c/recording" -X GET \
	-H "Access-Token: token123"

Respuesta

Simulated Response

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
  "status": "No available"
}

ForwardRequest

Forward Request permite y crea la interconexión entre dos números de teléfono, mediante paso de información a través de API, enmascarando y habilitando un DID aleatorio donde el primer teléfono llama y el sistema redirecciona la llamada al segundo número asociado a esta redirección.

Crear un forward requests

Creamos un forward request para generar un DID donde se debe llamar.

Punto de llegada

POST /forward_requests

Parametros

Name	Description	type	example
number_a requerido	Número desde donde se va realizar llamado. Formato nacional 9 digítos	string	987654321
number_b requerido	Número que va recibir llamado	string	987654325
access_token requerido	Token del API entregado por Medularis	string	p88sSrEcTPPaqRfVRoXYLas8Qokk3fys

Solicitud

Ruta

POST /forward_requests

Encabezados

Content-Type: application/json

Cuerpo

{
  "access_token": "VALID_TOKEN",
  "number_a": 987654321,
  "number_b": 987654322
}

cURL

curl "https://blindado.medularis.com/forward_requests" -d '{"access_token":"VALID_TOKEN","number_a":987654321,"number_b":987654322}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Respuesta

Simulated Response

Campos de respuesta

Name	Description
id	Identificador único
number_a	Número quien va realizar la llamada
number_b	Número donde se va recibir la llamada
did_number	DID donde `number_a` debe llamar para comunicarse con `number_b`
valid_at	Fecha y Hora en formato UTC ISO 8601 hasta cuando es válido
created_at	Fecha y Hora en formato UTC ISO 8601 cuando fue creado
time_now	Fecha y Hora en formato UTC ISO 8601 actual en el servidor
url	URL Endpoint donde consultar ésta información

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
  "id": "6d3e65ac-f5c2-4df8-95a1-4b04c2d1a92f",
  "number_a": "987654321",
  "number_b": "987654322",
  "tts": null,
  "did_number": "+56955004419",
  "extra_params": null,
  "created_at": "2020-02-24T18:40:05Z",
  "valid_at": "2020-02-24T18:41:05Z",
  "time_now": "2020-02-24T18:40:05Z",
  "url": "http://example.org/forward_requests/6d3e65ac-f5c2-4df8-95a1-4b04c2d1a92f.json"
}

Crear un forward requests y header de información

El header Blindado-Use-Percentage-Limit informa el porcentaje de ocupación que tiene mensualmente que tiene el plan de la empresa. Deberias chequear este header para prevenir fallos por corte de servicio. Para este ejemplo el API notifica un 91% de uso

Punto de llegada

POST /forward_requests

Parametros

Name	Description	type	example
number_a requerido	Número desde donde se va realizar llamado. Formato nacional 9 digítos	string	987654321
number_b requerido	Número que va recibir llamado	string	987654325
access_token requerido	Token del API entregado por Medularis	string	p88sSrEcTPPaqRfVRoXYLas8Qokk3fys

Solicitud

Ruta

POST /forward_requests

Encabezados

Content-Type: application/json

Cuerpo

{
  "access_token": "VALID_TOKEN",
  "number_a": 987654321,
  "number_b": 987654322
}

cURL

curl "https://blindado.medularis.com/forward_requests" -d '{"access_token":"VALID_TOKEN","number_a":987654321,"number_b":987654322}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Respuesta

Simulated Response

Campos de respuesta

Name	Description
id	Identificador único
number_a	Número quien va realizar la llamada
number_b	Número donde se va recibir la llamada
did_number	DID donde `number_a` debe llamar para comunicarse con `number_b`
valid_at	Fecha y Hora en formato UTC ISO 8601 hasta cuando es válido
created_at	Fecha y Hora en formato UTC ISO 8601 cuando fue creado
time_now	Fecha y Hora en formato UTC ISO 8601 actual en el servidor
url	URL Endpoint donde consultar ésta información

Estado

Encabezados

Blindado-Use-Percentage-Limit: 91
Content-Type: application/json; charset=utf-8

Cuerpo

{
  "id": "8ffd8c8e-4290-4ded-80c1-1ff8cd0756aa",
  "number_a": "987654321",
  "number_b": "987654322",
  "tts": null,
  "did_number": "+56955004419",
  "extra_params": null,
  "created_at": "2020-05-07T19:01:13Z",
  "valid_at": "2020-05-07T19:02:13Z",
  "time_now": "2020-05-07T19:01:13Z",
  "url": "http://example.org/forward_requests/8ffd8c8e-4290-4ded-80c1-1ff8cd0756aa.json"
}

Usando envio con TTS

Envio con TTS para ser reproducido en teléfono donde se recibe el llamado.

Punto de llegada

POST /forward_requests

Parametros

Name	Description	type	example
number_a requerido	Número desde donde se va realizar llamado. Formato nacional 9 digítos	string	987654321
number_b requerido	Número que va recibir llamado	string	987654325
access_token requerido	Token del API entregado por Medularis	string	p88sSrEcTPPaqRfVRoXYLas8Qokk3fys
tts	Texto a reproducir mediante TTS(Text To Speech) a teléfono donde se recibe el llamado	string	Hola, esta es una llamada de empresa X

Solicitud

Ruta

POST /forward_requests

Encabezados

Content-Type: application/json

Cuerpo

{
  "access_token": "VALID_TOKEN",
  "number_a": 987654321,
  "number_b": 987654322,
  "tts": "Mi tts a reproducir"
}

cURL

curl "https://blindado.medularis.com/forward_requests" -d '{"access_token":"VALID_TOKEN","number_a":987654321,"number_b":987654322,"tts":"Mi tts a reproducir"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Respuesta

Simulated Response

Campos de respuesta

Name	Description
id	Identificador único
number_a	Número quien va realizar la llamada
number_b	Número donde se va recibir la llamada
did_number	DID donde `number_a` debe llamar para comunicarse con `number_b`
valid_at	Fecha y Hora en formato UTC ISO 8601 hasta cuando es válido
created_at	Fecha y Hora en formato UTC ISO 8601 cuando fue creado
time_now	Fecha y Hora en formato UTC ISO 8601 actual en el servidor
url	URL Endpoint donde consultar ésta información
tts	TTS que se dicta a quien recibe la llamada

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
  "id": "07c6f1b1-00cd-4374-97bd-106d8f2bb6b7",
  "number_a": "987654321",
  "number_b": "987654322",
  "tts": "Mi tts a reproducir",
  "did_number": "+56955004419",
  "extra_params": null,
  "created_at": "2020-02-24T18:40:05Z",
  "valid_at": "2020-02-24T18:41:05Z",
  "time_now": "2020-02-24T18:40:05Z",
  "url": "http://example.org/forward_requests/07c6f1b1-00cd-4374-97bd-106d8f2bb6b7.json"
}

Usando envio con parámetros adicionales

Estos paramámtros serán almacenados y asociados para ForwardRequest solicitado.

Punto de llegada

POST /forward_requests

Parametros

Name	Description	type	example
number_a requerido	Número desde donde se va realizar llamado. Formato nacional 9 digítos	string	987654321
number_b requerido	Número que va recibir llamado	string	987654325
access_token requerido	Token del API entregado por Medularis	string	p88sSrEcTPPaqRfVRoXYLas8Qokk3fys
extra_params	Parámtros adicionales enviados	string	{codigo_id: 12}

Solicitud

Ruta

POST /forward_requests

Encabezados

Content-Type: application/json

Cuerpo

{
  "access_token": "VALID_TOKEN",
  "number_a": 987654321,
  "number_b": 987654322,
  "extra_params": "Codigo Mat y otros"
}

cURL

curl "https://blindado.medularis.com/forward_requests" -d '{"access_token":"VALID_TOKEN","number_a":987654321,"number_b":987654322,"extra_params":"Codigo Mat y otros"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Respuesta

Simulated Response

Campos de respuesta

Name	Description
id	Identificador único
number_a	Número quien va realizar la llamada
number_b	Número donde se va recibir la llamada
did_number	DID donde `number_a` debe llamar para comunicarse con `number_b`
valid_at	Fecha y Hora en formato UTC ISO 8601 hasta cuando es válido
created_at	Fecha y Hora en formato UTC ISO 8601 cuando fue creado
time_now	Fecha y Hora en formato UTC ISO 8601 actual en el servidor
url	URL Endpoint donde consultar ésta información
tts	Parámetros adicionales enviados

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
  "id": "c7b527d3-60b4-410e-91e1-ad303ee380cf",
  "number_a": "987654321",
  "number_b": "987654322",
  "tts": null,
  "did_number": "+56955004419",
  "extra_params": "Codigo Mat y otros",
  "created_at": "2020-02-24T18:40:05Z",
  "valid_at": "2020-02-24T18:41:05Z",
  "time_now": "2020-02-24T18:40:05Z",
  "url": "http://example.org/forward_requests/c7b527d3-60b4-410e-91e1-ad303ee380cf.json"
}

Sin DID disponibles

Cuando ya no existe la posibilidad de asignar mas DID por sobre uso de plataforma devuelve http 204.

Punto de llegada

POST /forward_requests

Parametros

Name	Description	type	example
number_a requerido	Número desde donde se va realizar llamado. Formato nacional 9 digítos	string	987654321
number_b requerido	Número que va recibir llamado	string	987654325
access_token requerido	Token del API entregado por Medularis	string	p88sSrEcTPPaqRfVRoXYLas8Qokk3fys

Solicitud

Ruta

POST /forward_requests

Encabezados

Content-Type: application/json

Cuerpo

{
  "access_token": "VALID_TOKEN",
  "number_a": 987654321,
  "number_b": 987654322
}

cURL

curl "https://blindado.medularis.com/forward_requests" -d '{"access_token":"VALID_TOKEN","number_a":987654321,"number_b":987654322}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Respuesta

Simulated Response

Campos de respuesta

Name	Description
id	Identificador único
number_a	Número quien va realizar la llamada
number_b	Número donde se va recibir la llamada
did_number	DID donde `number_a` debe llamar para comunicarse con `number_b`
valid_at	Fecha y Hora en formato UTC ISO 8601 hasta cuando es válido
created_at	Fecha y Hora en formato UTC ISO 8601 cuando fue creado
time_now	Fecha y Hora en formato UTC ISO 8601 actual en el servidor
url	URL Endpoint donde consultar ésta información

Estado

Limite excedido

Cuando la empresa tiene un plan y este se ha excedido del limite mensual asignado.

Punto de llegada

POST /forward_requests

Parametros

Name	Description	type	example
number_a requerido	Número desde donde se va realizar llamado. Formato nacional 9 digítos	string	987654321
number_b requerido	Número que va recibir llamado	string	987654325
access_token requerido	Token del API entregado por Medularis	string	p88sSrEcTPPaqRfVRoXYLas8Qokk3fys

Solicitud

Ruta

POST /forward_requests

Encabezados

Content-Type: application/json

Cuerpo

{
  "access_token": "VALID_TOKEN",
  "number_a": 987654321,
  "number_b": 987654322
}

cURL

curl "https://blindado.medularis.com/forward_requests" -d '{"access_token":"VALID_TOKEN","number_a":987654321,"number_b":987654322}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Respuesta

Simulated Response

Campos de respuesta

Name	Description
id	Identificador único
number_a	Número quien va realizar la llamada
number_b	Número donde se va recibir la llamada
did_number	DID donde `number_a` debe llamar para comunicarse con `number_b`
valid_at	Fecha y Hora en formato UTC ISO 8601 hasta cuando es válido
created_at	Fecha y Hora en formato UTC ISO 8601 cuando fue creado
time_now	Fecha y Hora en formato UTC ISO 8601 actual en el servidor
url	URL Endpoint donde consultar ésta información

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
  "error": "Limite de requests sobrepasado. Contactar soporte para detalles - blindado@medularis.com"
}

Respuesta Invalida

Al utilizar parámetros erroneos o un access_token inválido

Punto de llegada

POST /forward_requests

Parametros

Name	Description	type	example
number_a requerido	Número desde donde se va realizar llamado. Formato nacional 9 digítos	string	987654321
number_b requerido	Número que va recibir llamado	string	987654325
access_token requerido	Token del API entregado por Medularis	string	p88sSrEcTPPaqRfVRoXYLas8Qokk3fys

Solicitud

Ruta

POST /forward_requests

Encabezados

Content-Type: application/json

Cuerpo

{
  "access_api": "NO_VALID_TOKEN",
  "number_a": "987654321",
  "number_b": "987654322"
}

cURL

curl "https://blindado.medularis.com/forward_requests" -d '{"access_api":"NO_VALID_TOKEN","number_a":"987654321","number_b":"987654322"}' -X POST \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Respuesta

Simulated Response

Estado

Encabezados

Content-Type: application/json; charset=utf-8

Cuerpo

{
}

#Blindado API Documentación v1.6.0

#Blindado API Documentación v1.6.0

Calls

Respuesta

Estado

Encabezados

Cuerpo

Punto de llegada

Solicitud

Ruta

cURL

Respuesta

Estado

Encabezados

Cuerpo

Punto de llegada

Solicitud

Ruta

cURL

Respuesta

Campos de respuesta

Estado

Encabezados

Cuerpo

Punto de llegada

Solicitud

Ruta

cURL

Respuesta

Estado

Grabaciones

Grabacion de la llamada

Punto de llegada

Solicitud

Ruta

cURL

Respuesta

Estado

Encabezados

Cuerpo

Token no válido

Punto de llegada

Solicitud

Ruta

cURL

Respuesta

Estado

Encabezados

Cuerpo

Llamada no existe

Punto de llegada

Solicitud

Ruta

cURL

Respuesta

Estado

Encabezados

Cuerpo

No disponible

Punto de llegada

Solicitud

Ruta

cURL

Respuesta

Estado

Encabezados

Cuerpo

ForwardRequest

Crear un forward requests

Punto de llegada

Parametros

Solicitud

Ruta

Encabezados

Cuerpo

cURL

Respuesta

Campos de respuesta

Estado

Encabezados