FoneMa dispone de una API que le permite acceder a la información de su cuenta y realizar diversas operaciones desde sus propias aplicaciones.

Uso

La API se invoca mediante peticiones HTTP.

En los métodos GET los parámetros se deben indicar codificados en la URL y en los POST en formato JSON en el cuerpo de la petición HTTP.

Las respuestas se devuelven codificadas en JSON en el cuerpo de la respuesta.

La API requiere autenticación con un usuario y contraseña que son los mismos de acceso a la aplicación. El método login devuelve un token que es necesario proporcionar en una cabecera HTTP en el resto de peticiones:

Authorization: bearer “token”

 

Índice de métodos

Autenticación

login

Gestión de numeración

getDIDs
getDIDCountries
getDIDStates
getDIDGroups
buyDID
cancelDID

Clientes de ejemplo

PHP

Autenticación

login – GET


Este método permite obtener un token necesario para autenticar en el resto de métodos a partir del usuario y contraseña.

parámetros:

  • login: nombre de usuario con el que desea acceder a la API
  • password: contraseña del usuario

valores devueltos:

  • En caso de éxito, un JSON con el objeto response y la cadena token (response.token) que necesitará para acceder al resto de métodos.

 

 

Gestión de numeración

 

getDIDs – GET


Devuelve una lista de la numeración asignada a la cuenta.

parámetros:

  • Sin parámetros

valores devueltos:

  • Devuelve un array de objetos DID con las siguientes propiedades:
    • id: identificador del DID
    • number: número en formato E164
    • type: general ó personal
    • user: General si el número es general, o el nombre y número de extensión del usuario al que pertenece el número si es personal
    • description: descripción de la zona la que pertenece el DID
    • created: fecha de alta del DID
    • monthlyCost: precio mensual del DID

 

getDIDCountries – GET


Devuelve una lista de los países con numeración disponible.

parámetros:

  • type: tipo de la numeración. Uno de los siguientes valores:
    • GEOGRAPHIC: mostrar sólo países con numeración geográfica
    • TOLL_FREE: mostrar sólo países con numeración de coste gratuito para el llamante
    • NATIONAL: mostrar sólo países con numeración nacional
    • MOBILE: mostrar sólo países con numeración móvil
    • SHARED_COST: mostrar sólo países con numeración de coste compartido

valores devueltos:

  • Devuelve un array de objetos Country con la siguientes propiedades:
    • countryCodeA3: código del país
    • countryName: nombre del país
    • phoneCode: prefijo internacional del país
    • hasStates: 1 sí la numeración está organizada por estados (será necesario consultar el método getDIDStates para obtener el listado de estados).
    • hasRegulationRequirement: 1 si el país tiene regulación para la compra de numeración.

 

getDIDStates – GET


Devuelve la lista de estados de un país (sólo para países que tienen el campo hasStates a 1).

parámetros:

  • countryId: identificador countryCodeA3 del país del que se quieren obtener los estados (devuelto por el método getDIDCountries)

valores devueltos:

  • Devuelve un array de objetos State con las siguiente propiedades:
    • stateId: identificador numérico del estado
    • stateName: nombre del estado
    • stateCode: código del estado
    • countryCodeA3: código del país al que pertenece el estado

 

getDIDGroups – GET


Devuelve una lista de las zonas específicas de un país/tipo/estado de donde se puede adquirir numeración.

parámetros:

  • countryId: identificador countryCodeA3 del país del que se quieren obtener los estados (devuelto por el método getDIDCountries)
  • type: tipo de la numeración. Uno de los siguientes valores:
    • GEOGRAPHIC: mostrar sólo países con numeración geográfica
    • TOLL_FREE: mostrar sólo países con numeración de coste gratuito para el llamante
    • NATIONAL: mostrar sólo países con numeración nacional
    • MOBILE: mostrar sólo países con numeración móvil
    • SHARED_COST: mostrar sólo países con numeración de coste compartido
  • stateId: si el país tiene estados, uno de los identificadores devueltos por el método getDIDStates

valores devueltos:

  • Devuelve un array de objetos DIDGroup con las siguiente propiedades:
    • didGroupId: identificador numérico del grupo
    • cityName: nombre de la ciudad a la que pertenece el grupo
    • stock: cantidad de numeración disponible en stock
    • countryCodeA3: identificador del país al que pertenece el grupo
    • areaCode: prefijo telefónico de la numeración del grupo
    • setup100: precio de alta de la numeración del grupo (multiplicada por 100)
    • monthly100: precio mensual de la numeración del grupo (multiplicada por 100)
    • regulationRequirement: indica si existe regulación para el grupo de numeración. Si una dirección es necesario, la propiedad addressType tendrá los siguientes valores:
      • WORLDWIDE: es necesario indicar una dirección en cualquier país
      • NATIONAL: es necesario indicar una dirección en el país del grupo de numeración
      • LOCAL: es necesario indicar una dirección en la zona geográfica del grupo
      • Si además es necesario aportar una prueba para la dirección, se indicará en el campo proofRequired
    • available: indica si la numeración está disponible
    • description: descripción de la ciudad y prefijo

 

buyDID – POST


Realiza la compra de un número de un grupo determinado

parámetros:

  • countryId: identificador countryCodeA3 del país del que se quieren obtener los estados (devuelto por el método getDIDCountries)
  • type: tipo de la numeración. Uno de los siguientes valores:
    • GEOGRAPHIC: mostrar sólo países con numeración geográfica
    • TOLL_FREE: mostrar sólo países con numeración de coste gratuito para el llamante
    • NATIONAL: mostrar sólo países con numeración nacional
    • MOBILE: mostrar sólo países con numeración móvil
    • SHARED_COST: mostrar sólo países con numeración de coste compartido
  • stateId: si el país tiene estados, uno de los identificadores devueltos por el método getDIDStates
  • didGroupId: identificador del grupo obtenido del método getDIDGroups

valores devueltos:

  • Devuelve el identificador numérico del DID adquirido.

 

cancelDID – POST


Da de baja en la cuenta un número de teléfono.

parámetros:

  • didId: identificador numérico del DID (devuelto por buyDID o por getDIDs)

valores devueltos:

  • Devuelve OK en caso de éxito o un error 500 en caso de fallo.