Sign in
Phone Numbers

Rent a phone number from the telephony inventory

Rents an available number returned by GET /product/get-available-numbers. Charges the organization the prorated amount returned by GET /product/proration-amount immediately, then the monthly rate on each billing cycle.

Always call GET /product/proration-amount first to surface the immediate charge to your customer. The endpoint may return 200 with a body containing requiresAction: true when payment requires customer interaction (3-D Secure, etc.) — handle that branch in your client.

Released later via POST /product/release-number.

post/product/rent-number

Request body

phoneNumberstring required

The number to rent — exactly as returned by GET /product/get-available-numbers (no leading +).

provider'twilio' | 'plivo' | 'custom' | 'whatsapp' required

Example request

{
  "phoneNumber": "13183747513"
}

Response

Rental processed. Inspect data.requiresAction to determine whether the customer needs to complete a payment-method action.

statusboolean

Example response

{
  "status": true
}

Changes

Changed in 2 of the 54 revisions of this API.3

  • 49ce8525306e2See the full diff
    • ○

      added the new custom enum value to the request property

      request-property-enum-value-added

    • ○

      added the new whatsapp enum value to the request property

      request-property-enum-value-added

  • 4cc40f995db81See the full diff
    • ○

      endpoint added

      endpoint-added