Documentación de la API REST
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.
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.
Consultar el catálogo de países disponibles
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"La respuesta v3 contiene status y una matriz response. Las entradas de país incluyen isocode, name, countrycode, información de capacidades y next_function. La disponibilidad depende de la cuenta y del inventario; un país no garantiza que todos los prefijos o tipos de número estén en existencias.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}Del descubrimiento a la activación
- Elija el país, la subdivisión cuando sea necesaria, la zona y el tipo de número mediante las operaciones geográficas correspondientes.
- Consulte los precios de instalación, mensuales y de uso del número seleccionado, así como los canales, la franquicia incluida y los requisitos de registro.
- Envíe los documentos requeridos del usuario final y revise su estado. Un número puede permanecer pendiente hasta su aprobación.
- Haga el pedido una sola vez con la selección exacta de inventario y precio. Si la respuesta es incierta, revise su inventario antes de enviar otro pedido.
- Configure el encaminamiento de voz y la entrega de mensajes por separado y, a continuación, pruebe la ruta completa prevista.
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.