Documentación de la API REST
Realice su primera solicitud a la API de MultiTEL
Comience con una solicitud de solo lectura, comprenda la respuesta y luego elija la referencia para el servicio que desea construir.
Elija juntos la API y la credencial
Las cuentas aprobadas de Desarrolladores y Automatización, Empresa y Proveedores de comunicaciones pueden integrar los servicios habilitados. Un desarrollador individual no necesita fingir que es una empresa. Los SMS/MMS de aplicación requieren la aprobación de envío y el registro aplicables. El servicio Particulares y familias no dispone de ninguna API accesible al cliente para iniciar el envío de mensajes.
| Familia de API | URL base | Autenticación y resultado |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Credenciales Basic aprobadas; tokens provisionados admisibles solo para las operaciones que los admitan. JSON con status y response. |
| Registro del servicio de llamadas de emergencia | https://api.multi.tel/emergency | Credenciales Basic aprobadas o acceso bearer provisionado específicamente. JSON con code, message y data. |
| Integraciones REST del portal | Host y operación indicados en la referencia para desarrolladores de su cuenta | Utilice la credencial, los ámbitos y el esquema documentados para esa operación. Las solicitudes de sesión del navegador utilizan una interfaz aparte. |
Configure MULTITEL_API_USERNAME y MULTITEL_API_PASSWORD mediante la configuración de secretos de su servidor antes de utilizar los ejemplos. No los incluya nunca en código JavaScript público del navegador, en URL ni en el control de versiones. Las credenciales dedicadas se gestionan en los ajustes de integración de API.
Primera solicitud: consultar su saldo
Esta lectura no adquiere ningún servicio ni origina ninguna llamada o mensaje.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"La API v3 de comunicaciones devuelve un resultado de aplicación dentro del cuerpo JSON. Compruebe el estado HTTP y status.code antes de leer response; una solicitud rechazada puede no tener objeto de respuesta. Los valores de código pueden ser cadenas o números.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Esto es un ejemplo ficticio, no el saldo de una cuenta. Trate los valores monetarios como importes decimales. Conserve el mensaje de respuesta del servidor al diagnosticar una solicitud rechazada, eliminando las credenciales.
Utilice correctamente los datos de facturación
La respuesta de saldo contiene el saldo actual, la moneda y las condiciones de pago. No indica el coste de una llamada futura ni constituye una factura completa. Utilice las operaciones correspondientes de tarifas y uso para esas preguntas. Los números existentes pueden tener planes diferentes a los del catálogo actual.
Elija su próxima integración
API REST de búsqueda de enrutamiento LRN
Consulte el número de encaminamiento y la información del operador disponible para un número telefónico norteamericano a un precio fijo por consulta.
Leer la guía de integración →APIs REST de números telefónicos
Descubra los países y números disponibles, examine la oferta completa y gestione los números que posee.
Leer la guía de integración →APIs REST de SMS y MMS
Envíe mensajes aprobados de la aplicación y gestione la aceptación, los eventos de entrega, la segmentación y los cargos.
Leer la guía de integración →APIs REST de llamadas de emergencia
Registre un número y la dirección del servicio, siga su estado de activación y mantenga el registro actualizado a medida que cambie la ubicación.
Leer la guía de integración →APIs REST de cuenta y facturación
Consulte el saldo y la información de facturación disponible para su integración aprobada.
Leer la guía de integración →CNAM y búsquedas de enrutamiento
Lea los nombres de los llamantes, comprenda los niveles de consulta y utilice la información de encaminamiento de números.
Referencia CNAM REST →PBX alojado
Comience con los planes de servicio disponibles y el entorno de cliente (tenant) que desea configurar.
API de planes de servicio PBX alojado →Gestión de errores y reintentos
- Fallo de autenticación o de permiso
- Compruebe el estado habilitado de la credencial de API, el servicio permitido y la restricción de IP de origen. Una cookie de sesión del portal no es una credencial de integración.
- Crédito insuficiente o aprobación pendiente
- Resuelva el saldo de la cuenta, la aprobación de envío o el requisito de documentación antes de repetir la operación.
- Sin resultado
- Trate el inventario vacío o la falta de nombre del llamante como un resultado normal. No suponga que un número sintácticamente válido dispone de todos los servicios.
- Tiempo de espera de red o fallo del servicio
- Utilice reintentos limitados con espera progresiva para las lecturas. Para una compra, un envío o un registro, compruebe primero el estado de la operación; reintentar una solicitud aceptada puede duplicar una acción facturable.
La compatibilidad con la idempotencia pertenece a cada familia de API. La API de emergencias admite claves de reintento; esto no hace que las solicitudes arbitrarias de la v3 sean idempotentes. Conserve las marcas de tiempo, los identificadores devueltos y las respuestas expurgadas para el soporte.
Continúe con la referencia de su cuenta
La referencia disponible tras iniciar sesión filtra las operaciones según sus permisos y servicios habilitados. Utilice el host exacto, el tipo de credencial, los campos de solicitud y el esquema de respuesta indicados. Las consolas pueden ejecutar operaciones reales, incluidas compras y envíos de mensajes.