Alquilar un número

Un alquiler conserva un número durante un plazo fijo y recibe todos los mensajes que se le envían mientras dure ese plazo. Hay dos tipos:

• General: recibe de cualquier remitente.

• Reservado para una plataforma: un número apartado para una sola plataforma (WhatsApp, por ejemplo), para cuando una plataforma solo acepta los suyos.

Busca lo que puedes alquilar

Estas tres llamadas son públicas: no necesitas clave de API. Sin clave muestran los precios de lista públicos; envía tu clave para ver los precios de tu cuenta, que son los que se te cobrarán en un alquiler. Una clave incorrecta se rechaza con 403. Consulta Autenticación.

1. Países

   curl https://numestri.com/api/v1/rental/retrieve_all

   { "success": 1, "data": [ { "id": "US", "name": "United States" } ] }

2. Plataformas con números reservados (opcional)

   curl "https://numestri.com/api/v1/rental/retrieve_platforms?id=US"

   {
     "success": 1,
     "country": "US",
     "data": [
       {
         "id": "whatsapp",
         "name": "WhatsApp",
         "from_price": "3.90",
         "from_price_cents": 390
       }
     ]
   }

3. Plazos, precios y opciones

   Añade service para un número reservado; omítelo para uno general.

   curl "https://numestri.com/api/v1/rental/retrieve_pricing?id=US&service=whatsapp"

   {
     "success": 1,
     "country": "US",
     "service": { "id": "whatsapp", "name": "WhatsApp" },
     "pricing": { "7": "4.94", "30": "12.35" },
     "plans": [
       {
         "days": 7, "cost": "4.94", "cost_in_cents": 494, "quality": null, "in_stock": true, "renewable": true,
         "options": [
           { "option": "Qm3tV8xLs0PaWd2E", "provider": "prv_k3Jd9QmXa2", "rank": 1, "cost": "4.94", "in_stock": true, "renewable": true }
         ]
       }
     ]
   }

   renewable indica si el plazo se podrá ampliar más adelante en el mismo número. Compruébalo antes de alquilar un número que quieras conservar. extend (el mismo mapa que pricing) es lo que cuesta otro plazo.

   Un país sin nada para alquilar (o sin nada reservado para esa plataforma allí) devuelve un 404 con param: "id", que te remite a retrieve_all o retrieve_platforms. Un id de service desconocido devuelve un 400.

Alquílalo

Alquilar, y todo lo que viene después, requiere una clave de API.

curl https://numestri.com/api/v1/purchase/rental -H "Authorization: Bearer $NUMESTRI_KEY" \
  -d id=US -d days=7 -d service=whatsapp

{
  "success": 1,
  "rental_code": "SNBW9MPY",
  "phonenumber": "15550109876",
  "service_id": "whatsapp",
  "days": 7,
  "expiration_date": 1792736400,
  "renewable": true,
  "can_extend": true,
  "can_reset": true
}

Lee sus mensajes

curl "https://numestri.com/api/v1/rental/retrieve_messages?rental_code=SNBW9MPY" -H "Authorization: Bearer $NUMESTRI_KEY"

{
  "success": 1,
  "messages": [
    {
      "sender": "WhatsApp",
      "message": "Your code is 553-311",
      "code": "553311"
    }
  ]
}

Los alquileres reciben los mensajes completos; code es el código de verificación que encontramos en cada uno. Para recibirlos sin intervenir, añade un webhook: cada mensaje dispara rental.received.

Consérvalo, arréglalo o devuélvelo